0
ecosense-api

ecosense-api

A RESTful API built with ExpressJS and TypeScript for CRUD operation from EcoSense mobile and web applications.

About

A RESTful API built with ExpressJS and TypeScript for CRUD operation.
This is the backend application server for EcoSense Indonesia.

Run the Server Locally

  1. Clone the repository.
  2. Install the dependencies using npm install.
  3. Run cp .env.example .env to create an environment variable file.
  4. Fill the environment variables in .env file.
  5. Run the server using npm run start:dev.
  6. The server will be running on http://localhost:3001.
  7. To stop the server, press Ctrl + C in your terminal.

Technologies

JavaScript NPM NodeJS ExpressJS TypeScript Postgres Google Cloud

Dependencies

Production

@google-cloud/secret-manager @google-cloud/storage cors dotenv express firebase-admin multer pg

Development

jest supertest ts-jest typescript

Go to List of Dependencies

Google Cloud Platform Infrastructure

Production

Development

Peripherals

  • Google Cloud Storage
    • Bucket for Campaign Posters: ecosense-campaign-posters
    • Bucket for Task Completion Proof: ecosense-task-proofs

CI/CD Workflows (Production & Development)

  1. Push to GitHub Repository EcoSenseID/EcoSense-API
  2. Wait until the GitHub Actions workflow run is done.

2023 © EcoSense Indonesia.