Built with React on the frontend and Express, Knex.js, and PostgreSQL on the backend, BulletsX is a fullstack bullet management system, offering bullet drafting, tracking, and reporting capabilities for supervisors and subordinates.
git clonethe project URL or download and extract the .ZIP archive.
- NPM
- Docker
- A PostgreSQL Docker image
- Start a Docker PostgreSQL instance with the following:
- username:
postgres - password:
docker - port:
5432:5432
$ docker run --name instance-name -e POSTGRES_PASSWORD=docker -d -p 5432:5432 postgres - username:
- Create a database named bullet in the PostgreSQL instance.
-
$ docker exec -it postgres-instance-container-id bash -
# psql -U postgres -
# CREATE DATABASE inventory;
-
- Create a
.envin theserverf older with the following contents:CLIENT_PORT=3000 SERVER_PORT=3001 DATABASE_PORT=5432 USER_NAME=postgres USER_PASSWORD=docker DATABASE_NAME=bullets
From the client directory, run npm i to install dependencies then run npm run dev to start the client.
From the server directory, run npm i to install dependencies then either run npm start to rollback, migrate, and seed the database and then start the server or npm start to only start the server.
BulletsX has over 80% test coverage. To run tests, navigate to the appropriate directory (server or client) and run:
npm run testIn order to use BulletsX, you create or sign into an account.
- From the Log In page, click Create Account. This will redirect you to the Sign Up page.
- Input your First and Last Name and desired Username and Password.
- Select your Rank/Grade from the dropdown list.
- Select your Rank/Grade from the dropdown list.
- Select your Supervisor.
- Click the Submit button. If the username is available, your account will be created.
- From the Log In page, input your Username and Password.
- Click the Submit button. If authenticated, you will be redirected to the Home page.
- From the Home page, you can:
- Review Award-Winning Bullets and Upcoming Awards.
- Add Activities.
- Navigate to the Bullets page.
- Toggling the hamburger (☰) allows you to navigate to:
- Your Home page.
- Your Profile page.
- Your Activity page.
- Your Bullets page.
- The Upcoming Awards page.
- My Awards page.
- Your Subordinates page.
- Toggling your Profile picture also allows you to:
- Navigate to the Edit Profile page.
- Log out.
- Toggle Light/Dark Mode.
There isn’t a centralized location to draft bullets, regularly track awards and accomplishments, and collab with your supervisor through it all. Our app provides a dashboard for users to create and track award goals, as well as regularly log their notable work activity for performance reporting.
Made with https://sql.toad.cz
- Isaiah Aguirre
- Oscar Avina
- Ethan Diem
- Gerald Gann
- Damon Hayes
- Ashley Reynolds
- Brook Sharpenski
- Tia Tomescu
Adam Brace for the template.