/ai-for-homework-expressjs

Primary LanguageTypeScript

Getting Started

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

  • Node.js (v14 or later)
  • npm (Node Package Manager, included with Node.js)
  • Git

Setup Instructions

1. Clone the Repository

First, clone the repository to your local machine using Git.

git clone https://github.com/your-username/[app-name].git
cd [app-name]

2. Install Dependencies

Navigate to the project directory and install the required dependencies.

yarn

3. Configure Environment Variables

Create a .env file in the root directory of the project and add your environment-specific variables. You can use the provided .env.example file as a reference.

cp .env.example .env

Edit the .env file to match your environment configuration.

4. Run the Development Server

Start the development server with the following command. This will also watch for any changes in your code and automatically restart the server.

yarn start:dev

5. Run the Production Server

To run the application in a production environment, use the following command:

yarn start

7. Verify the Setup

Open your browser and navigate to http://localhost:8080 to verify that the application is running correctly.

Versioning

This project is versioned to ensure backward compatibility and easy maintenance. The current version is [version 1].

route naming conventions

all routes should have a prefix of

  api/v1