ondo-backend

Backend implementation of ondo
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
     • Environment
     • Set up .env
     • Set up git hook
   • Installation
3. Roadmap
4. Contributing
5. Contact

About The Project

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Environment

• Install docker
• Install docker compose plugin
• Install the below vscode extension
  • vscode-remote-extensionpack
• Click the bottom-left corner button and select Open Folder in Container...

Set up .env

• Create a new file named .env at the root of the project.

• Set up the .env file and set the key and values like below.

  • OPEN_WEATHER_APPID can get from OpenWeather.
  • JWT_SECRET_KEY and JWT_REFRESH_KEY is for jwt. You can make a secure secret key by running openssl rand -hex 32.
  • TWILIO can get from twilio.

  OPEN_WEATHER_APPID="xxxxxxxxxxxxxxxxxxxx"
  ASYNC_DATABASE_URL="postgresql+asyncpg://postgres:postgres@localhost:5432/postgres"
  SYNC_DATABASE_URL="postgresql+psycopg2://postgres:postgres@localhost:5432/postgres"
  JWT_SECRET_KEY="xxxxxxxxxxxxxxxxxxxx"
  JWT_REFRESH_KEY="xxxxxxxxxxxxxxxxxxxx"
  TWILIO_SID = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  TWILIO_AUTH_TOKEN = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  TWILIO_VIRTUAL_NUMBER = "+xxxxxxxxxxx"
  TWILIO_VERIFIED_NUMBER = "+xxxxxxxxxxxx"

Set up git hook

git config --local core.hooksPath .githooks
sudo chmod a+x .githooks/pre-push

Installation

Note If you want to check what commands are available, type make.

1. Create the tables

   make reset-table

2. Seed data

   make seed

3. Run server

   make run

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

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

Contact

Project Link: https://github.com/team-ondo/backend

(back to top)