readme and last fixes

README.md

@@ -1,68 +1,58 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# Athena October 2022 Hackathon - FoodPrint
 
-## Available Scripts
+Our submission for the Athena Hcakathon in October 2022 on the theme "How can households reduce their carbon footprint?".
 
-In the project directory, you can run:
+FoodPrint is a web app that tackles food consumption's impact on carbon footprint emissions.
 
-### `npm start`
+## App Features
+- Scans users’ groceries receipt to calculate the food items’ carbon footprint 
+- Sends reminders to users to avoid food waste
+- Awards points for low carbon footprint food consumption to encourage users 
+- Tracks previous receipts’ scans to help users’ track their impact
 
-Runs the app in the development mode.<br />
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+We use an OCR API to detect text in the receipt image and take into account the seasonality and type of the food items to calculate their carbon footprint.
 
-The page will reload if you make edits.<br />
-You will also see any lint errors in the console.
+## Future improvements
+- Implementing reminders via mobile messaging (SMS, WhatsApp, Telegram)
+- Connecting users to local food producers with search and messaging features
 
-### `npm test`
+## Hackathon 
+We teamed up for the Hackathon and had a great time imagining and building this app from scratch in only 35 hours!
 
-Launches the test runner in the interactive watch mode.<br />
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+## Tech stack
+React, Node.js, Express, PostgreSQL, OCR API <br />
 
-### `npm run build`
+## Local installation 
 
-Builds the app for production to the `build` folder.<br />
-It correctly bundles React in production mode and optimizes the build for the best performance.
+- Clone the repository 
 
-The build is minified and the filenames include the hashes.<br />
-Your app is ready to be deployed!
+- Install dependencies 
+```bash
+npm install
+```
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+- Set up a PostgreSQL database:
 
-### `npm run eject`
+Set up a PostgreSQL database (download [PostgreSQL](https://www.postgresql.org/download/) if necessary) and add the database credentials in a `.env` file. Once the database is created, connect to your database `psql -d databaseName`, and create the tables found in `database/tables`.
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+- Run a development server:
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+Concurrently in 2 different tabs:
+```bash
+npm start
+```
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+```bash
+cd client 
+npm start
+```
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+## Credits
+Audrey (developer), Sowjanya(developer), Kate (developer), Nadia (designer), Adeola (designer)
 
-## Learn More
+## Screenshots 
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
-
-### Analyzing the Bundle Size
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
-
-### Making a Progressive Web App
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
-
-### Advanced Configuration
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
-
-### Deployment
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
-
-### `npm run build` fails to minify
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
+![home.png]
+![dashboard-1.png]
+![dashboard-2.png]
+![dashboard-3.png]