Compost Hub

Social networking app that connects supplier, producers, and consumers of organic household waste.
Explore the docs »

Built With

Frontend

• React.js
• Redux
• React-leaflet
• React-bootstrap
• Typescript

Backend

• Typescript
• Express
• PostgreSQL
• Prisma
• JWT
• Stripe API
• JEST
• AWS S3
• AWS RDS (Optional)
• AWS Lambda (Optional)
• AWS SES (Optional)
• Serverless Framework (Optional)
• Webpack (Optional)

(back to top)

Getting Started

There's a few things you need to do to get started:

Prerequisites

• npm

• API Keys

  Stripe & Stripe webhook, AWS S3 bucket, AWS SES

• Database you need to install postgres local database & put it in the server local .env

Installation

• Clone the repo

  git clone https://github.com/pmcc12/CompostApp.git

Client

1. Install NPM packages

   • CompostApp/client

   npm i

2. Enter your API key & credentials in your local .env

Server

1. Install NPM packages

   • In CompostApp/server

   npm i

2. Install Prisma CLI

   • npx prisma generate

   • Create table (Do Migration)

     npx prisma migrate dev --name "init" --preview-feature

3. Create Amazon S3 config

   Put in the .env

4. Stripe checkout

   Put in the .env

5. Stripe webhooks

   Use ngrok to make localhost accessible

   put the webhook endpoint & registered it in stripe dashboard webhook

   Choose:

   • charge.succeeded
   • checkout.session.completed

   Put in the .env

6. To use Email ses,

   Put the aws config in .env

   put the email_source & email_ReplyToAddresses in .env

7. npm start

8. Optional

   if you want to deploy the backend in AWS Lambda

   sls deploy

   You must provide the:

   serverless config credentials — provider aws — key <your-access-key-id> — secret <your-secret-key>

(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)