We are making a Bookstore App that renders on both mobile and desktop web devices natively. Users and employees will have the ability to create an account, login, browse and purchase books, and more. Ultimately, we hope that this web application will be used by local businesses to grow their web presence and increase revenue.
In order to build this project install:
- Node Package Manager
- Node.js
- All of the required packages, APIs, and libraries - description for how to do this in Setup.
Before running the app a few things have to be installed in both the client and backend. Run these instructions in the terminal:
Ensure you are in "BufferOverload" and run these commands:
npm i
cd into the backend folder and run: npm i
cd into the client folder and run: npm i && npm run build
NOTE: If you are running locally, you will need a .env file which contains, among other things,
private keys for authentication. Contact the developers for more information about this.
To run the app make sure to cd into the base-folder (Buffer-Overload) and run npm start in the terminal.
The terminal should tell you what port it launches on (usually 3001). Navigate to localhost:3001/ or equivalent.
To deploy our bookstore web application we plan on using Heroku. Embedded into Heroku comes the option of using the mongoDB database which will be used for storing user information and the book inventory. Integrated with this, we plan to use the Amazon API for book browsing and potential book purchases. The stored user information and book inventory will follow JSON formatting. https://www.heroku.com/
In using Heroku as the method to deploy our bookstore web application, we will be using Docker containers for development. Using these containers for our web app are essential because they are small, executable packages which are easy to use for development and running the application. The up side to Docker is that it is faster, scalable, and easy to use compared to virtual-machines. https://www.docker.com/
We will use a traditional web app model because the Heroku hosting platform will easily handle the small load of server operations for our app.
We have both unit and integration tests for our app.
Our unit tests require Jest, which is one of our project dependencies and can be installed with npm i.
Our end-to-end tests require Cypress, which requires a bit more setup. After installing in the client folder with npm i, you will need to run npm run cypress:open to configure the default web browser you wish to run the integration tests on. After that, close the browser, and you can run the tests with the instructions below.
The automated unit tests can be run with cd backend && npm run test from the home directory. The server and react pages need not be running to run the unit tests.
The end-to-end tests run on Cypress and can be run after the server is running. In a terminal, run the server with npm run build and then npm run start. After that, open a new terminal, and run npm run cypress:test from the client folder.
All of our unit tests are located in the /backend/routes folder and named *.test.js. All of our integration tests are located in the /client/cypress/e2e/ folder.
- Rahul Bulusu: [email protected]
- William Hobbs: [email protected]
- Jack Oberman: [email protected]
- Sai Oruganti: [email protected]
- Alfred Lin: [email protected]