About The Project

This repo or project reduces many time that you spent to prepare nodejs typscript app and have many endpoints with their boilerplate code and the right description where presented with in the backend api's or in this README.md file so that endpoints are included by user api roles and permissions permission categories and user image uploading to AWS S3 Bucket and is authenticated and authorized api's .

Here's why:

• Reduces many time to hook up a new project
• Well presented API
• API has great security and many preventions like no-sql-injection
• Descriptive Code and has great comments to understand the code
• This App implements senior Folder Structure
• Typescript based server api's

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is prerequisites of how the project will work with you

• npm

  npm and node js must be installed on your machine.

Installation

_Below is an example of how you can instruct your audience on installing and setting up your app.

1. Clone the repo

   git clone https://github.com/abdi-aaqyaar/nodejs-rest-api-ts-template.git

2. Install NPM packages

   npm install

3. Enter your Configurations in .env

   PORT = 8000;
   NODE_ENV = "development or production";
   JWT_SECRET_KEY = jwt_secret_key;
   JWT_EXPIRES_IN = "day or hour or year";
   MONGO_URI = "your mongodb uri";
   
   // email setup
   SMTP_SERVER = "host provider";
   SMTP_PORT = "your host port number";
   SMTP_USER = "your email";
   SMTP_KEY = "app password key generated by your email";

4. Before Starting The Project npm start or npm run dev commands you must be build the project by executing this command npm run build after that npm run dev to start the development server and runs concurrency for typescript compilation and running nodemon for nodejs server.

5. Deploying The Project on your own server

this category is not ready now

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Abdi Zamed - @Follow my twitter

Project Link: https://github.com/abdi-aaqyaar/nodejs-rest-api-ts-template