Hello books is an application that provides users with access to books from wherever they are. Being a virtual library, users can borrow and read their favorite books using any device. HelloBooks exposes RESTful API endpoints such that anyone can customize their method of consuming the resources.
# Clone your fork of this repository # Ensure NodeJS, PostgreSQL and Sequelize cli are globally installed # Switch to project directory cd helloBooks # Install dependencies npm install # Set up environment variables Follow the template in .env.example # Run database migrations npm run migrate:dev # Start the app - In development mode, run the following from two separate terminal windows/tabs npm run start:client npm run start:dev navigate to http://localhost:8080 in your browser - For production build, run: npm run build then npm run start
For client-side tests, run
npm run test:client
For server-side tests, run
npm run test:server
For both, run
For end to end tests, start by running
npm run e2e-setup
Then start the client by running
npm run start:client.
In another terminal window, run
npm run start:server:e2e to start the application server in test-mode.
In a third terminal window run
npm run e2e-server to start the selenium server.
In a fourth terminal window run
npm run test:e2e
Hello books is open source and contributions are highly welcomed.
If you would like to contribute, follow the instructions below.
NB: All Pull requests must be made against development branch. Pull Requests against master would be rejected.
See project wiki for coding style guide, commit message, pull request and branch naming conventions.
This project is published under the MIT License. Ckeck the License.md for details.