Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardomrcruz authored Nov 17, 2024
1 parent ac8d801 commit b46da50
Showing 1 changed file with 69 additions and 7 deletions.
76 changes: 69 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,73 @@
# Welcome to GreenFoot - From Les Pattes Carbone
# GreenFoot - Carbon Footprint Calculator Interface

![GreenFoot Banner](https://github.com/user-attachments/assets/82b5c273-e6db-4df5-b940-07c90da96fe0)

## Overview

Règles :
GreenFoot is an open-source carbon footprint calculator application developed collaboratively by multiple developers. It provides an intuitive interface for users to track and analyze their carbon footprint through various metrics and visualizations.

- le nom de la branche doit correspondre à la feature (ex: fix/nomDuFix ou feature/nomDeLaFeature)
- le reviewer gère sa review mais ne merge pas la PR et ne supprime pas la branche
- avant de push, récupérer la dernière version de dev pour éviter les conflits
- merger dev sur main en fin de sprint
- commits explicites
## Tech Stack

### Backend
- Node.js
- Apollo Server
- TypeORM
- TypeGraphQL
- JWT Authentication

### Frontend
- React
- Next.js
- Flowbite UI Components

### Testing
- Playwright for E2E testing
- Jest for unit testing

## Application Screenshots

![Screenshot](https://github.com/user-attachments/assets/458bcab4-a474-44cb-9fc4-fef610cbd427)
![Screenshot](https://github.com/user-attachments/assets/246cc6c4-cd42-4972-8bb4-0b20b93a4392)
![Screenshot](https://github.com/user-attachments/assets/e3229f16-665c-4708-82e2-9b26493bdc68)
![Screenshot](https://github.com/user-attachments/assets/3fa0a8ac-26bb-441d-8d8a-fde22a541863)
![Screenshot](https://github.com/user-attachments/assets/c2238e38-17f5-4813-bdbb-3692ac3fdedd)
![Screenshot](https://github.com/user-attachments/assets/a3b9c742-86e0-491f-bf2d-94224f4d0630)
![Screenshot](https://github.com/user-attachments/assets/6067f871-b1a0-41db-8bc8-1b7cedd12f77)
![Screenshot](https://github.com/user-attachments/assets/a33d1f2f-cca6-4585-8155-174780fb6fd1)
![Screenshot](https://github.com/user-attachments/assets/5707e677-e23a-4544-aeaa-f890cf88fe53)
![Screenshot](https://github.com/user-attachments/assets/cdfd3cad-df56-486f-ae2c-d4d7cc204827)

## Getting Started

1. Clone the repository
```bash
git clone https://github.com/yourusername/greenfoot.git
```

2. Install dependencies
```bash
cd greenfoot
npm install
```

3. Set up environment variables
```bash
cp .env.example .env
```

4. Run development server
```bash
npm run dev
```

## Contributing

We welcome contributions from the community! Please read our contributing guidelines before submitting a pull request.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

## Acknowledgments

Special thanks to all the developers who have contributed to making GreenFoot possible.

0 comments on commit b46da50

Please sign in to comment.