rusefi
/
msqur
mirror of https://github.com/rusefi/msqur.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
281 Commits 4 Branches 17 Tags 7.4 MiB
JavaScript 52.6%
PHP 29.6%
HTML 10.2%
TeX 2.7%
CSS 2.4%
Other 2.5%
Go to file
Nick 2243d8e8e7 Fix viewing cached msq 2019-11-08 09:19:05 -06:00
.travis Update CI & Deployment scripts (#22) 2019-10-14 23:22:24 -05:00
db add logfile, and initial db script. l2git 2016-03-31 12:39:05 -04:00
doxygen Working on API and filter. 2015-10-14 21:31:38 -04:00
src Fix viewing cached msq 2019-11-08 09:19:05 -06:00
tests yolo 2019-10-14 21:23:56 -05:00
.codeclimate.yml Update CI & Deployment scripts (#22) 2019-10-14 23:22:24 -05:00
.csslintrc Update CI & Deployment scripts (#22) 2019-10-14 23:22:24 -05:00
.eslintignore Update CI & Deployment scripts (#22) 2019-10-14 23:22:24 -05:00
.eslintrc Update CI & Deployment scripts (#22) 2019-10-14 23:22:24 -05:00
.gitignore Update CI & Deployment scripts (#22) 2019-10-14 23:22:24 -05:00
.travis.yml Ok, have to upgrade for phpunit. Sigh. 2019-11-07 23:11:10 -06:00
LICENSE.md Update splash page. Fix license formatting. Update readme. 2015-09-29 16:55:34 -04:00
README.md Cleanup. rm greentext, improve about/readme/etc 2019-11-04 20:24:41 -06:00
backup.sh add backup script. 2016-03-31 01:02:44 -04:00
deploy.sh add version string to deploy script 2019-11-05 10:21:09 -06:00
deploy_excludes.txt Update CI & Deployment scripts (#22) 2019-10-14 23:22:24 -05:00
ini-parsing.txt Working on API and filter. 2015-10-14 21:31:38 -04:00
script.config.dist add backup script. 2016-03-31 01:02:44 -04:00
setup.sh api work. search added. browse upgrade. some html5 improvements. 2016-03-20 18:26:27 -04:00
update-db.sh add backup script. 2016-03-31 01:02:44 -04:00

README.md

MSQur

MegaSquirt MSQ file sharing and viewing site.

Pronounced 'masker' I guess? Supposed to be a play on imgur.

Parses MSQ "XML" in tandem with an associated INI (config) file and displays it in a familiar format for viewing and comparing.

Try it now at: https://msqur.com

Build Status:

Development status

Firmware support:

  • MS1
  • MSnS-extra (partial)
  • MS2
  • MS2Extra
  • MS3
  • Speeduino

Contributing

This is basically a one-man operation. I welcome any contributions: code, styles, text content, or simply spelling & grammar. If you're interesting in helping out, please first take a look at the existing issues and see if you can offer any assistance with them. If you don't see your issue or new idea listed there you can create a new issue. Please be detailed.

If you'd like to run a copy to develop yourself, read the Installation section below.

Installation

Needed software

  • PHP 7.x with the following extensions:
    • PDO
    • OpenSSL
  • MySQL/MariaDB

Optional software

  • Web server (Apache/nginx/etc.)
  • phpMyAdmin - For managing the DB

Development Setup

These steps could be improved

  1. Clone repo to dev directory
  2. Create database for msqur, and assign it a user
  3. Copy script.config.dist to script.config and modify for use (setup DB connection information)
  4. Copy src/config.php.dist to src/config.php (setup DB information again)
  5. Update DB with update scripts in sequential order (patse into phpMyAdmin or piped to sqlcmd, etc.)
  6. Hit webserver to start using it (eg. php -S, etc.)

Source tree description

  • db - Database scripts
  • doxygen - Doxygen configuration and generated code documentation
  • src - PHP source
    • ini - Megasquirt configuration files
    • view - PHP/JS frontend source
      • lib - JS 3rd party libraries
      • img - Static images
    • tests - PHP Unit Tests (TODO)

Update & Deployment Instructions

These steps are outdated

  • Pull updates on host.
  • Update any configuration files (config.php, script.config) if needed.
  • Run any new DB scripts.
  • Run deploy.sh to copy web files to web server.

License

msqur is licensed under the GPL v3.0. A copy of this license is included in the LICENSE.md file in the source tree.

Who do I talk to?

Credits

This section needs to be updated