Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Complete project template for building RESTful API with Typescript.
https://github.com/arifintahu/project-structure-api

expressjs project-template rest-api typescript

Last synced: 7 days ago
JSON representation

Complete project template for building RESTful API with Typescript.

Host: GitHub
URL: https://github.com/arifintahu/project-structure-api
Owner: arifintahu
Created: 2021-09-28T23:45:25.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-03-10T22:57:20.000Z (8 months ago)
Last Synced: 2024-04-23T20:00:51.138Z (7 months ago)
Topics: expressjs, project-template, rest-api, typescript
Language: TypeScript
Homepage:
Size: 629 KB
Stars: 128
Watchers: 3
Forks: 23
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]

Project Structure API

Complete project template for building RESTful API with Typescript

Report Bug
·
Request Feature

Table of Contents

About The Project
- Built With

Getting Started
- Prerequisites
- Installation

Usage

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](https://expressjs.com/)
- [Sequelize](https://sequelize.org/)
- [Swagger](https://swagger.io/)
- [Typescript](https://www.typescriptlang.org/)
- [JsonWebToken](https://www.npmjs.com/package/jsonwebtoken)
- [Postgresql](https://www.postgresql.org/)
- [Jest](https://jestjs.io/)

(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](https://github.com/arifintahu/project-structure-api/generate)

### Prerequisites

Before installation, make sure you have the following prerequisites

- NPM
```sh
npm install npm@latest -g
```
- Postgresql server

### Installation

1. Clone the repo or simply select [use this template](https://github.com/arifintahu/project-structure-api/generate)
```sh
git clone https://github.com/arifintahu/project-structure-api.git
```
2. Install NPM packages
```sh
npm ci
```
3. Create `.env` file in main directory
4. Copy and customize envs from `.env.example`
5. Test and build the project
```sh
npm run build
```
6. Sync database tables
```sh
npm run sync-db
```
7. Run the server
```sh
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)

[contributors-shield]: https://img.shields.io/github/contributors/arifintahu/project-structure-api.svg?style=for-the-badge
[contributors-url]: https://github.com/arifintahu/project-structure-api/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/arifintahu/project-structure-api.svg?style=for-the-badge
[forks-url]: https://github.com/arifintahu/project-structure-api/network/members
[stars-shield]: https://img.shields.io/github/stars/arifintahu/project-structure-api.svg?style=for-the-badge
[stars-url]: https://github.com/arifintahu/project-structure-api/stargazers
[issues-shield]: https://img.shields.io/github/issues/arifintahu/project-structure-api.svg?style=for-the-badge
[issues-url]: https://github.com/arifintahu/project-structure-api/issues