WIP: An open-source web application that creates chord/lyric "box charts" for songwriting and jamming.
- Deployed Site
- Overview
- Getting Started
- Built With
- Contributing
- Versioning
- Authors
- License
- Project History
- Acknowledgements
This is currently a work in progress; it will eventually be deployed at http://boxcharter.com.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
To run this project, you'll need
- Node.js 8.x
- nvm
- PostgreSQL 9.x
See INSTALLING.md for details.
Log on to http://localhost:8080 to access the client front end. The Express server, by default, runs on port 3090.
$ npm test
This will run:
- Server tests
- Client tests
- End to End tests
Coming in the future...
- Back End
- Front End
See CONTRIBUTING.md for details.
This project uses ESLint, with the AirBnB base.
To check linting, run npm run lint from the top level. This will check linting on both
client and server JavaScript. Note that this uses the --fix flag and will automatically fix errors that can be fixed without human intervention.
Coming in the future...
- Bonnie Schulkin - Initial work
BoxCharter is licensed under the GNU Affero General Public License.
This has been a learning project for me. I started with a Python Flask back end and an AngularJS / Clarity front end to learn AngularJS. Then I switched to using Node.js and React/Redux on the job, and refactored this to have a Node Express back end and React/Redux on the front end to learn those technologies.
- Many thanks to Stephen Grider for his outstanding React courses on Udemy!