README.md

EcoQuest

The application is a community-based game that promotes sustainable living by engaging users in activities that encourage responsible consumption. Upon completing these events, users can earn credits that can be redeemed for prizes.

Inital setup

Prerequisites NodeJS LTS v16.17.0

1. Install nvm on your machine
2. run nvm install v16.17.0
3. run nvm use
4. Run npm install in the working directory to install required packages
5. Reference .env.example and create your own .env file
6. Run npm run start to start the server on localhost

Documentation

• Live Site
• Figma Design

File Structure and Naming Convention

src/
├─ api/
│  ├─ ApiHandler.ts
│  ├─ ApiService.ts
├─ assets/
├─ components/
│  ├─ ExampleComponent/
│  │  ├─ ExampleComponent.tsx
│  │  ├─ index.ts
├─ constants/
├─ pages/
│  ├─ Home/
│  │  ├─ Home.tsx
│  │  ├─ index.ts
├─ utils/
│  ├─ hooks/
│  ├─ contexts/
│  ├─ miscellaneous.ts

Commit Message Convention

• Use Gitmoji to add emojis to your commit messages
• Use the following format for your commit messages
  • ✨ feat: add new feature
  • 🐛 fix: fix a bug
  • ♻️ refactor: refactor code
  • 🎨 style: change styling
  • 🔥 chore: remove unused code
  • 📝 docs: update documentation
  • 📦 package: update package
  • 🚀 deploy: deploy to production
  • 🗑️ waste: remove unused code