[Description]

|--- src
|    |--- index.ts
|--- .env.local
|--- .gitignore
|--- package.json
|--- tsconfig.json

• Node.js
• TypeScript
• Express
• ts-node-dev

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

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

For example:

git clone [email protected]:this-is-you/hng_project.git

where this-is-you is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.

Change to the repository directory on your computer (if you are not already there):

cd hng_project

Now create a branch using the git switch command:

git switch -c your-new-branch-name

For example:

git switch -c add-alonzo-church

  console.log

is not allowed

a default logger has been created

  import log from "./utils/logger";

  log.info("information")

Make your changes to the codebase. Ensure your code follows the project's coding standards and guidelines.

Now open Contributors.md file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

Push your changes using the command git push:

git push -u origin your-branch-name

replacing your-branch-name with the name of the branch you created earlier.

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

Now submit the pull request.

Soon your changes will be merged into the staging branch of this project. You will get a notification email once the changes have been merged.

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

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

Navigate to the project directory and install the required dependencies.

yarn

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.

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

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

yarn start

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

All API endpoints can be referenced in the API Reference document.

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

all routes should have a prefix of

  api/v1