/backend

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0


ExpressJS Project

StartEase

Overview

Welcome to your project generated using StartEase! This guide will walk you through the basic configuration steps to get your backend project up and running.

Prerequisites

Before you begin, make sure you have the following prerequisites installed on your system:

  • Node.js and npm: Download and install Node.js from nodejs.org.

Installation

Install project dependencies using npm :

npm install

OR

Install project dependencies using yarn :

yarn install

Configuration

Environment Variables

Your project relies on environment variables for configuration. To set up these variables:

  1. Create a .env file in the project root directory.

  2. Add the following environment variables to the .env file:

    APP_NAME=YourAppName
    APP_PORT=3000
    APP_ENV=development
    

    Note: configuration variables should be added based on config in the environment.js file.

Replace YourAppName, your-database-url, your-database-name, etc., with your actual project and database information.

Start the Project

Once you've configured your environment variables, you can start your project:

npm run dev

Your backend server should now be running at http://localhost:.

Collaborators

Toyin5
Toyin Muhammed
Klin-Coders
Bayode Emmanuel
Chimise
Chisom Promise
JC-Coder
Null

Contributors

Klin-Coders
Bayode Emmanuel
TheOnlyAbdull
Abdullahi Salaudeen
JC-Coder
JC CODER - Snr Javascript Engineer
Chimise
Chisom Promise
jemmycodes
Otebele Jemimah