Anthropology Inventory Mangement Application 💀🔍

This app is built to help Green River College's Anthropology department in organizing and tracking their artifact inventory.

Tools used & Links:

• Electron-Vite: Used to create a lightweight app with Electron and Vite.
• React: Helped to reduce redundancy through the use of components.
• Node.js: For the backend API.
• Express.js: Framework for Node.js, helped streamline development.
• MongoDB: Opted for Mongo due to the clients budget constraint and desire to keep application local.
• npm-run-all: Used to run both front and backend simultaneously with one script.

Table of contents:

• How to contribute
• Credits

How to Contribute

1. To contribute first create a branch and name it according to the feature/update you'll be working on.
   • This branch is where you'll be pushing your changes.
2. In your development environment of choice, create a copy of the repo.
   • Prior to coding, ensure you're working within the correct branch.
3. From the main folder:
   • run npm run install to install all dependencies needed.
4. Next, change directories into the api folder:
   • Within the folder is a _.env.example file, use this to create a .env file.
   • The file should include:
     • PORT=____ where you specify a port for the api to run, this should be different from the frontend.
     • MONGO_URI=___ this variable will need to be requested and shouldn't be shared.
     • Lastly, ensure the .env file is added into the .gitignore file. This is important in maintaining security.
5. After, change directiories back to the main using cd ..
   • run npm run dev and both the frontend and backend will be started.

Credits

Dev Team

This app was built by:

• @Gecervantes01
• @Mingrkli
• @kaur000
• @brandonviorato

Client

We created this app in partnership with our client Madeleine Aguilar -- a professor working in the Department of Anthropology at Green River College. She'll be the main point of contact moving forward in regards to the future of the project.