arifintahu / project-structure-api

Complete project template for building RESTful API with Typescript.

Project Structure API

Complete project template for building RESTful API with Typescript

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing

About The Project

Building project with standardized structure could save much our time. We could focus on business process without considering too much on project structure. On the other hand, a good project structure should be clean, nice refactored, and easy to maintain.

Here's why:

• Your time should be focused on creating something amazing. A project that solves a problem and helps others.
• You shouldn't be doing the same tasks over and over like structuring project
• You should implement dry principles to the rest of your life

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this project template!

(back to top)

Built With

This project structure is built using

• Express.js
• Sequelize
• Swagger
• Typescript
• JsonWebToken
• Postgresql
• Jest

(back to top)

Features

• Everything is modular and unit testable
• Typescript everything
• Project API structures with routes, controllers, models, repositories, middlewares, and services
• Centralized configuration input validator

Folder Structure

├── .husky/                     # Pre-commit config for lint staged
├── docs/                       # Swagger API docs
├── src/                        # All application source
├──── @types/                   # Type definition for modules
|
├──── api/
├────── controllers/            # Define all controllers
├────── middlewares/            # Define all middlewares
├────── models/                 # Define all sequelize models
├────── repositories/           # Define all repositories
├────── routes/
├──────── v1/                   # Define all v1 routes
├────── services/               # Define all services
├────── types/                  # Define all input types
|
├──── config/
├────── appConfig.ts            # Define app configuration
|
├──── constants/                # Define all constants
├──── database/                 # Define database connection and sync tables
├──── utils/                    # Define reusable libs
├──── server.ts                 # Create express config
├──── index.ts                  # ENTRYPOINT - Start server
|
└── ...

Getting Started

To start project, just clone this repo or Use this template

Prerequisites

Before installation, make sure you have the following prerequisites

• NPM

  npm install npm@latest -g

• Postgresql server

Installation

1. Clone the repo or simply select use this template

   git clone https://github.com/arifintahu/project-structure-api.git

2. Install NPM packages

   npm ci

3. Create .env file in main directory
4. Copy and customize envs from .env.example
5. Test and build the project

   npm run build

6. Sync database tables

   npm run sync-db

7. Run the server

   npm run start

8. Access swagger docs from localhost:3001/docs/v1

(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/feature-name)
3. Commit your Changes (git commit -m 'Add some feature-name')
4. Push to the Branch (git push origin feature/feature-name)
5. Open a Pull Request

(back to top)

project-structure-api's Issues

.env.example

can we create a .env.example file having the names of environment variables

No configuration for run with local environment

Hi,

for application running need to do npm run build and the npm run start.

for each file changes need to do build and then start server, that`s not best-case
need to setup for local configuration run server with ts

suggested: nodemon src/index.js

No sequelize schema migration found ?

schema migration is the best feature where we can create tables,alter colums, need to setup for migrations

How to add more association to login model

I am having an issue adding more relations to login model

This is how I am adding just after importing the Business model

Login.belongsTo(User, {
foreignKey: 'user_id'
});

Login.belongsTo(Business, {
foreignKey: 'business_id'
});

ERROR: relation "business" does not exist

please assist thanks

postgresapp how to create .env

I start the postgresapp for postgres developping,

NODE_ENV=development
PORT=3001
DB_HOST=localhost
DB_NAME=【my system username】
DB_USER=【my system username】
DB_PASS=
DB_PORT=5432
DB_LOG=true

it doesn't work

what can i do