Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/burhon97/express-server

database dokcer express js mysql nodejs server typescript

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/burhon97/express-server
Owner: burhon97
Created: 2024-04-17T18:42:18.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-06-19T13:33:17.000Z (7 months ago)
Last Synced: 2024-06-19T23:54:20.867Z (7 months ago)
Topics: database, dokcer, express, js, mysql, nodejs, server, typescript
Language: TypeScript
Homepage:
Size: 2.34 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Express Server

This example `express.js` server for sign-up/sign-in and upload/get/download file.

## Requirements

- [Node.js](https://nodejs.org/en/download)

- [Docker](https://www.docker.com/products/docker-desktop/)

## Installation

```

npm install

```

## Usage

### Run external service with Docker

Create necessary volume by running:

```shell

docker volume create mydb

```

Then run docker-compose to start MySQL:

```shell

docker-compose up -d

```

### Start server

To start server you need at the first compile

```

npm run watch

```

After successfully compiling you can start server

```

npm start

```

### Send request with Postman

Add Postman collection from `./postman_collection.json` directory into [Postman](https://www.postman.com/).

> **NOTE** Check your `Bearer Token`, is it not invalid or revoked.

**`sign-up`**

Make request `sign-up-request` for registration:

![sign-up](./assets/sign-up.png)

**`sign-in`**

Make request `sign-in-request` for sign in and you get your `jwt` token:

![sign-in](./assets/sign-in.png)

**`new-token`**

Make request `sign-in-new-token-request` for new `jwt` token:

![refresh-token](./assets/new-token.png)

**`upload-file`**

Make request `upload-file-request` for upload file:

![upload-file](./assets/upload.png)

**`list-file`**

Make request `file-list-request` for get list files:

![list-file](./assets/file-list.png)

**`delete-file`**

Make request `delete-file-request` for delete file by id:

![delete-file](./assets/delete.png)

**`get-file`**

Make request `get-file-request` for get file by id:

![get-file](./assets/get-file.png)

**`download-file`**

Make request `download-file-request` for download file by id:

![download-file](./assets/download.png)

**`update-file`**

Make request `update-file-request` for update file by id:

![update-file](./assets/update.png)

**`info`**

Make request `info-request` for get info user:

![info](./assets/info.png)

**`logout`**

Make request `logout-request` for logged out (revoke token):

![logout](./assets/logout.png)