https://github.com/richeyphu/express-comcraft

Express.js final project (ITE-497)
https://github.com/richeyphu/express-comcraft

api docker esbuild express jest mongodb mongoose nodejs rest-api typescript university-project

Last synced: 3 months ago
JSON representation

Express.js final project (ITE-497)

• Host: GitHub
• URL: https://github.com/richeyphu/express-comcraft
• Owner: richeyphu
• License: mit
• Created: 2023-01-26T20:15:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T10:04:04.000Z (over 3 years ago)
• Last Synced: 2026-01-03T12:28:03.459Z (6 months ago)
• Topics: api, docker, esbuild, express, jest, mongodb, mongoose, nodejs, rest-api, typescript, university-project
• Language: TypeScript
• Homepage:
• Size: 642 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# express-comcraft

![cover](public/images/cover.png)



RESTful API server for a computer store, built with Express.js, MongoDB and ❤️



> _The final project of `Build RESTful API with MongoDB, Node.js and Express` (ITE-497) course._

## Usage

### Setup

- Install dependencies

```sh

$ pnpm i

```

- Config environment variables (`.env`)

  - Example:

```env

PORT=3000

MONGODB_URI=Your_MongoDB_URI_for_dev

MONGODB_URI_TEST=Your_MongoDB_URI_for_test

DOMAIN=http://localhost:3000

JWT_SECRET=Your_JWT_Secret

```

### Run

- Start development server

```sh

$ pnpm dev

```

- Start the server

```sh

$ pnpm start

```

- Test, bundle, and build a Docker Image, respectively

```sh

$ pnpm build:docker

```

## Documentation

API documentation is available at [Postman](https://documenter.getpostman.com/view/8888210/2s93CPprQ5).

[![Postman](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=Postman&logoColor=white)](https://documenter.getpostman.com/view/8888210/2s93CPprQ5)

## License

Licensed under the [MIT License](LICENSE).