Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/charan379/moviebunkers

Moviebunkers API, Yet Another Movie Data Base ( MBDB )
https://github.com/charan379/moviebunkers

mbdb movie movie-database moviebunkers movies movies-api react4movies

Last synced: about 1 month ago
JSON representation

Moviebunkers API, Yet Another Movie Data Base ( MBDB )

Awesome Lists containing this project

README

        

# moviebunkers :clapper:

[![VERSION](https://img.shields.io/badge/VERSION-v3-sucess)](https://github.com/charan379/moviebunkers) [![LAST UPDATE](https://img.shields.io/badge/LAST--UPDATED-28--February--2024-sucess)](https://github.com/charan379/moviebunkers) [![AGPL License](https://img.shields.io/badge/LICENSE-GNU%20AGPLv3-informational)](https://www.gnu.org/licenses/agpl-3.0.en.html)

This is REST API application. Developed using Express, Nodejs , Typescript

## Environment Variables

To run this project, you will need to add the following environment variables to your .env file

`DOMAIN_NAME`
`MONGODB_SERVER_STRING`
`HTTPS`
`COOKIE_SECRET`
`JWT_SECRET`
`CORS_ORIGINS`
`SUPER_ADMIN`
`MAIL_SERVICE_PROVIDER`
`MAIL_SERVICE_HOST`
`MAIL_SERVICE_PORT`
`MAIL_SERVICE_AUTH_USER`
`MAIL_SERVICE_AUTH_PASSWORD`
`PORT`
`NODE_ENV`

#### Example

`DOMAIN_NAME`=localhost
`MONGODB_SERVER_STRING`=mongodb://127.0.0.1:27017/moviebunkers
`HTTPS`=false
`COOKIE_SECRET`=my cookie secret
`JWT_SECRE`T=my jwt secret key
`CORS_ORIGINS`=http://localhost:3080,http://yourapp.com
`PORT`=3010
`NODE_ENV`=production

## Run

Clone the project

```bash
git clone https://github.com/charan379/moviebunkers.git
```

Go to the project directory

```bash
cd moviebunkers
```

Add Environment Variables then
Install dependencies

```bash
npm install
```

Start the server

```bash
npm run start
```

Start the server in dev

```bash
npm run dev
```

Server will start running on given port

### Post-Installation

#### Swagger Documentation

```bash
http://localhost:PORT/api-docs
```

![Swagger-docs-preview](documentation/moviebunkers-swagger.gif)

## Authors

- [@charan379](https://www.github.com/charan379)

## License

[![AGPL License](https://img.shields.io/badge/LICENSE-GNU%20AGPLv3-brightgreen)](https://www.gnu.org/licenses/agpl-3.0.en.html)