/ecoleta

NLW#1 Rocketseat

Primary LanguageTypeScript

Ecoleta

Application for registration of recyclable materials collection point

✋🏻 Prerequisites

Layout

Installation

Clone the repository, and install the dependencies by running the following commands:

  $ git clone https://github.com/jmamadeu/ecoleta.git
  $ cd ecoleta
  $ cd backend
  $ yarn # or npm install
  $ cd frontend/web && frontend/mobile
  $ yarn # or npm install

Running the Backend or API

  $ cd backend
  $ yarn dev # or npm run dev

Running the Frontend

  $ cd frontend

For running the frontend

  $ cd web # cd mobile
  $ yarn start # or npm start

Contribution

Contributions are what make the open source community an incredible place to learn, inspire and create. Any contribution you make will be ** very valuable and appreciated **.

  1. Fork the project
  2. Create a Branch for your Feature (git checkout -b feature/IncredibleFeature)
  3. Add your changes (git add .)
  4. Commit your changes (git commit -m 'Adding an awesome Feature!)
  5. Push the Branch (git push origin feature/FeatureIncrivel)
  6. Open a Pull Request

Author

João Amadeu