Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vbrazhnik/movie-catalog
Movie Catalog [MERN stack]
https://github.com/vbrazhnik/movie-catalog
express-js mern-stack mongodb movie-catalog movies-api node-js react-js restful-api
Last synced: about 1 month ago
JSON representation
Movie Catalog [MERN stack]
- Host: GitHub
- URL: https://github.com/vbrazhnik/movie-catalog
- Owner: VBrazhnik
- Created: 2019-02-04T06:42:57.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-11T21:34:26.000Z (almost 6 years ago)
- Last Synced: 2024-02-05T15:53:08.604Z (11 months ago)
- Topics: express-js, mern-stack, mongodb, movie-catalog, movies-api, node-js, react-js, restful-api
- Language: JavaScript
- Homepage:
- Size: 1.2 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Movie Catalog
Movie Catalog was developed using MongoDB, Express.js, React.js and Node.js.
## Installation
Clone repository and install node modules:
```
$ git clone
$ cd /client
$ npm i
$ cd ../server
$ npm i
```
## Configuration
You have to modify a few files for your environment.
At first, you have to modify `server/config/default.json`.
And maybe you have to modify the following line in `client/package.json`:
```
"proxy": "http://localhost:5000"
```
## Execution
Run server-side and client-side parts of the project:
```
$ cd server
$ npm start
```
If you want to display debug-messages, set environment variable `DEBUG`:
```
$ DEBUG=app:* npm start
```
## Testing
You can run a few tests for server-side part of the project.
Tests are located in `server/test` folder. You can run them with the following command:
```
$ npm test
```
## Movie
### Structure
Field|Data Type|Required|Restrictions
:-----|:-----|:-----|:-----
`title`|String|Required|No longer than 100 characters
`year`|Number|Required|No less than 1800 and no more than 3000
`format`|String|Required|`VHS` or `DVD` or `Blu-Ray`
`stars`|Array of Strings|Required|Each string is no longer than 100 characters and at least one string must be present
### Schema
```
const Movie = new mongoose.model('Movie', new mongoose.Schema({
title: {
type: String,
required: true,
maxlength: 100
},
year: {
type: Number,
required: true,
min: 1800,
max: 3000
},
format: {
type: String,
required: true,
enum: formats
},
stars: {
type: [{
type: String,
maxlength: 100
}],
required: true
}
}));
```
### Server-Side Data Validation
Joi module is used to validate data on the server.
```
const validate = (movie) => {
const schema = {
title: Joi.string().max(100).required(),
year: Joi.number().min(1800).max(3000).required(),
format: Joi.string().valid(formats).required(),
stars: Joi.array().items(Joi.string().max(100)).min(1).required()
};
return (Joi.validate(movie, schema));
};
```
### Client-Side Data Validation
Form validation is used to validate input on the client-side.
## Architecture
### Server
Express.js is used for handling http-requests.
Mongoose is used for work with MongoDB.
#### RESTful API
URL|HTTP Method|Body of Request|Response
:-----|:-----|:-----|:-----
`/api/movies`|`GET`|—|All movies
`/api/movies?title=`|`GET`|—|All movies that match ``
`/api/movies?star=`|`GET`|—|All movies which stars list contains ``
`/api/movies`|`POST`|JSON|Created movie
`/api/movies/upload`|`POST`|File|All created movies
`/api/movies/:id`|`DELETE`|—|Deleted movie
### Client
React.js, Redux and Bootstrap are used to create client-side part of Movie Catalog.
