csivitu / lostandfound

Lost and Found

Connecting lost belongings with their owners

Lost and Found

A web application facilitating the reporting of lost items, searching for found items, and fostering a community-driven approach to reuniting owners with their lost belongings.

Table of Contents

• Tech stack used
• Build Instructions
• Contributing

Tech stack used

Frontend

• ReactJS
• Bootstrap

Backend

• NodeJS
• ExpressJS
• SQLite

Build instructions

To run the project, run the following commands in both the frontend and backend directories.

npm install
npm start

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork this repository.
2. Clone it on your local machine.

   git clone https://github.com/your-github-username/LostAndFound.git

3. Navigate to the project directory

   cd LostAndFound

4. Create a new branch.

   git checkout -b feature/new-feature

5. Make your changes, add and commit them.

   git add .
   git commit -m 'Added a new feature'

6. Push to the branch.

   git push origin feature/new-feature
   

7. Submit a pull request.