Skip to content

Latest commit

 

History

History
231 lines (159 loc) · 7.39 KB

README.md

File metadata and controls

231 lines (159 loc) · 7.39 KB
Raw

Developer Console API

This repository hosts the codebase for the DIMO Developer Console API, powering the platform at https://console.dimo.xyz. The API facilitates seamless interactions and management of developer tools and resources within the DIMO ecosystem.

Table of Contents

Getting Started

These instructions will guide you on setting up the project locally.

Prerequisites

Before you begin, ensure you have the following installed on your machine:

Set Up Google and GitHub OAuth Applications

  1. Create a Google OAuth App:
  • Go to the Google Developer Console.
  • Create a new project (if you don’t already have one).
  • Navigate to OAuth consent screen and configure it.
  • Under Credentials, create an OAuth 2.0 Client ID.
  • Add a Redirect URI: http://localhost:3000/api/auth/callback/google.
  • Ensure the app has access to the People API:
    • Go to Library and search for "People API".
    • Enable the People API for your project.
  • Note down your Client ID and Client Secret. These will be used in your environment variables.
  1. Create a GitHub OAuth App:

Installation

  1. Clone the repository:
git clone git@github.com:DIMO-Network/dimo-developer-console-api.git
cd dimo-developer-console-api
  1. Set up environment variables:
  • Create a .env.local file in the root directory of the project:
GITHUB_CLIENT_ID=<YOUR_GITHUB_CLIENT_ID>
GITHUB_CLIENT_SECRET=<YOUR_GITHUB_CLIENT_SECRET>

GOOGLE_CLIENT_ID=<YOUR_GOOGLE_CLIENT_ID>
GOOGLE_CLIENT_SECRET=<YOUR_GOOGLE_CLIENT_SECRET>

PGHOST=<YOUR_PG_HOST>
PGUSER=<YOUR_PG_USER>
PGDATABASE=<YOUR_PG_DATABASE>
PGPASSWORD=<YOUR_PG_PASSWORD>
PGPORT=<YOUR_PG_PORT>

ZAPIER_LEAD_WEBHOOK_PATH=<ZAPIER LEAD GENERATION PATH, empty for dev environments>

NEXTAUTH_SECRET=<YOUR_NEXTAUTH_SECRET>
NEXTAUTH_URL=http://localhost:3000/
  1. Database Setup:
  • Start the PostgreSQL instance using Docker:
docker-compose up -d
  • This command will start a PostgreSQL instance on your local machine as defined in the docker-compose.yml file.
  1. Install the dependencies:
npm install
# or
yarn install

Running the Development Server

Start the development server:

npm run dev
# or
yarn dev

Building for Production

To create an optimized production build:

npm run build
# or
yarn build

To start the production server:

npm run start
# or
yarn start

Project Structure

A brief description of the main folders and files in the project:

  • ./src/app/api: Contains all the application API routes using the new App Router in Next.js.
  • ./src/config: Configuration files
    • default is mainly used for the development environment and default values in staging and prod
    • preview is mainly used for changing variable values in the staging environment.
    • production is mainly used for changing variable values in the production environment.
  • ./src/controllers: Handles the logic for processing requests and returning responses in the application.
  • ./src/services: Contains the business logic of the application, interacting with the database, APIs, and other services.
  • ./src/models: Sequelize models that define the schema and relationships of the PostgreSQL database.
  • ./src/scripts: Scripts used for initializing PostgreSQL with Docker.
  • ./src/types: TypeScript type definitions and interfaces used throughout the application.
  • ./src/utils: Utility functions and helper methods that are used across different parts of the application.

Technologies Used

  • Next.js: A React framework for server-side rendering, static site generation, and more.
  • PostgreSQL: A powerful, open-source relational database system.
  • JavaScript/ES6+: Modern JavaScript syntax and features.

Database Setup

  1. Ensure Docker is installed and running on your machine.

  2. Set up environment variables:

  • Make sure the PG related variables in your .env.local file is configured to connect to the PostgreSQL instance that will be created by Docker. Your .env.local file should look something like this:
PGHOST=<YOUR_PG_HOST>
PGUSER=<YOUR_PG_USER>
PGDATABASE=<YOUR_PG_DATABASE>
PGPASSWORD=<YOUR_PG_PASSWORD>
PGPORT=<YOUR_PG_PORT>
  • Replace username, password, localhost, 5432, and the database name with your specific PostgreSQL credentials, host, port, and database name as defined in the docker-compose.yml file.
  1. Start the PostgreSQL instance using Docker:
  • Run the following command to start the Docker containers defined in your docker-compose.yml file:
docker-compose up -d
  • This command will start a PostgreSQL instance on your local machine, accessible via the credentials and settings specified in the PG environment variables.
  1. You can connect to the PostgreSQL instance using a database management tool like pgAdmin or via the command line to verify the setup.

Contributing

We welcome contributions to this project! If you would like to contribute, please follow these steps:

  1. Fork the repository on GitHub by clicking the "Fork" button at the top right of the repository page.

  2. Clone your forked repository to your local machine:

git clone https://github.com/your-username/your-forked-repository.git
cd your-forked-repository
  1. Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name

  1. Make your changes in the codebase.

  2. Commit your changes with a clear and concise commit message:

git commit -m "Add feature/fix: Describe your changes"
  1. Push your changes to your forked repository on GitHub:
git push origin feature/your-feature-name
  1. Open a Pull Request:
  • Go to the original repository on GitHub.
  • Click on the "Pull Requests" tab.
  • Click the "New Pull Request" button.
  • Select the branch you made your changes on and submit the Pull Request.

  1. Describe your changes in the Pull Request. Provide as much detail as possible about what you’ve done and why.

  2. Wait for a review from the maintainers. They may ask for changes or provide feedback.

  3. Once your Pull Request is approved, it will be merged into the main branch.

Thank you for contributing to the project!