README.md

Coletaí WEB ♻️

Description

Coletaí's main objective is to bring recycling cooperatives closer to people who sort recyclable waste at home.

Registered users can request collections from the cooperatives, which in turn have the option of accepting or not the requests.

Table of Contents

• Coletaí WEB ♻️
  • Description
  • Table of Contents
  • Mockups
  • Features
  • Built With
  • Running the Project

Mockups

Features

• Sign Up - User and cooperative registration;
• Sign In - Log in as an user or cooperative;
• Request Collection - As an user, create a collection;
• Finish Collection - As a cooperative, finish the collection request;
• Cancel Collection - As a cooperative, cancel the collection request.
• Find Cooperatives - Find nearby cooperatives looking at the homepage map;

Built With

Running the Project

1. Clone the repository:

   git clone https://github.com/akiraTatesawa/coletai-front.git

2. Navigate to the project directory

   cd coletai-front/

3. Install the dependencies

   npm install

4. Set your environment variables following the .env.sample file:

   Name	Type
   VITE_API_URL	string

5. Run the project on dev mode and have fun!

   npm run dev