MichaelAquilina / freecycle-web-app

freecycle-web-app

Freecycle ("SecondLife") Web App

A place to give and get stuff for free in London.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

(back to top)

Built With

• React
• Express
• Mysql
• Vanilla CSS

(back to top)

Getting started

Prerequisites

• Run npm install in project directory to install server-related dependencies such as express.
• cd client and run npm install to install client dependencies (React).
• install nodemon, mysql, cors, material ui, react router dom

Installation

• Access the MySQL interface in your terminal by running mysql -u root -p
• Create a new database called items: create database items
• Add a .env file to the project folder of this repository containing the MySQL authentication information for MySQL user. For example:

  DB_HOST=localhost
  DB_USER=root
  DB_NAME=items
  DB_PASS=YOURPASSWORD

• Run npm run migrate in the project folder of this repository, in a new terminal window. This will create a table called 'items' in your database.

(back to top)

Usage

Database schema

(back to top)

Roadmap

• Add User Login
• Add categories
• Add image upload / multiple images functionality
• Add pagination

See the open issues for a full list of proposed features (and known issues).

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Katja Pollmann - LinkedIn Profile - [e-mail]

Project Link: https://github.com/kpo18/freecycle-web-app

(back to top)