Skip to content

karoliam/Foodbase-web

Repository files navigation

4th-period-2k22-project

Name

Foodbase

Description

This web-application is developed for bringing together people with excess food and people with a need for food. The application helps reduce food waste and also brings good spirit to the community.

###Principles

  1. Mobile first
  2. User privacy and security (Although security is not top notch currently)
  3. Ease of use (intuitive UI)

###Different roles in the application

####Anonymous users can: 1. Browse the feed 2. Open posts 3. Search for posts with keywords and filters

####Registered users can do the same, plus: 4. Get their feed automatically filtered according to their preferences 5. Send messages to post authors and chat with them 6. Flag disturbing posts 7. Create posts and edit them 8. Edit their profile and change password (email not editable) 9. Delete their posts or their account

####Moderators can do the same, plus: 10.See all flagged posts, the amount of reports per post and the report messages for each post 11.Delete clearly inappropriate posts that have been reported multiple times

Installation

  1. Clone the repo
  2. Install MariaDB on your localhost or virtual server
  3. run the script from tablesForDB.txt, located in project root
  4. Configure your .env in the project folder with:
    1. DB_HOST=your server address or 127.0.0.1
    2. DB_NAME=foodbase
    3. DB_USER=your configured server user
    4. DB_PASS=your password
    5. JWT_SECRET=random string
  5. Install Node.js
  6. Run npm i
  7. Run npm start
  8. Deploy in localhost or virtual server.

Support

You can send an email to reimani@metropolia.fi if you encounter a problem or have questions.

Roadmap

This project's next development steps could be:

  1. A direct, realtime connection between chatting users
  2. Notifications for new unread messages.
  3. Rating for users (from successful/unsuccessful "trades").
  4. Automated post deletion after a set amount of time.

Contributing

As of 6.5.2022 there are no active contributors.

Authors

Karoliina Multas, Reima Nikola, Vili Mäkinen.

License

This project follows the guidelines of General Public License v3.0 and thus, everyone is free to use parts or all of our code as long as the original authors are credited clearly. The whole license is found in project root folder

Project status

Summer break

SPECIAL THANKS

###Ilkka Kylmäniemi - For front-end/back-end exercise materials that helped a lot in the project. ###Patrick Ausderau - For helping with database logic. ###Ulla Sederlöf - For hinting that we missed the meta tag for mobile users.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published