/risevest

Primary LanguageTypeScript

RiseVest TEST API

Introduction

This API serves as the backend for the RiseVest TEST. It provides endpoints for user management, posts, comments, and more.

Getting Started

Running with Docker

  1. Create a .env.development.local file in the root directory of the project.
  2. Inside the .env.development.local file, configure environment variables based on your requirements.
  3. Open a terminal and navigate to the root directory of the risevest-api project.
  4. Run the following command to start the development environment using Docker:
make dev

Running Without Docker

  1. Change your working directory to risevest/.
  2. Create a .env.development.local file in the risevest/ directory.
  3. Configure the environment variables in the .env.development.local file.
  4. Open a terminal and navigate to the risevest/ directory.
  5. Run the following command to start the development server without Docker:
npm run dev

Query Optimization Task

For information about the Query Optimization Task, refer to the queryOptimizationTask.txt file in the repository.

Access

Documentation

For detailed documentation about the available endpoints, request formats, and responses, please refer to the official API documentation.