-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README and Contributing, update axios and jsonwebtoken and fix ve…
…rcel
- Loading branch information
1 parent
0f7aa72
commit 97eb559
Showing
6 changed files
with
203 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Contributing to WMovies API | ||
|
||
First off, thank you for considering contributing to WMovies API. It's people like you that make WMovies API such a great tool. | ||
|
||
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
This section guides you through submitting a bug report for WMovies API. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. | ||
|
||
- Use a clear and descriptive title for the issue to identify the problem. | ||
- Describe the exact steps which reproduce the problem in as many details as possible. | ||
- Provide specific examples to demonstrate the steps. | ||
|
||
### Suggesting Enhancements | ||
|
||
This section guides you through submitting an enhancement suggestion for WMovies API, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions. | ||
|
||
- Use a clear and descriptive title for the issue to identify the suggestion. | ||
- Provide a step-by-step description of the suggested enhancement in as many details as possible. | ||
- Provide specific examples to demonstrate the steps. | ||
|
||
### Pull Requests | ||
|
||
The process described here has several goals: | ||
|
||
- Maintain WMovies API's quality | ||
- Fix problems that are important to users | ||
- Engage the community in working toward the best possible WMovies API | ||
- Enable a sustainable system for WMovies API's maintainers to review contributions | ||
|
||
Please follow these steps to have your contribution considered by the maintainers: | ||
|
||
- Follow all instructions in the template | ||
- After you submit your pull request, verify that all status checks are passing | ||
- While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# WMovies API | ||
|
||
This is the server-side codebase for the WMovies project. It's a Node.js application that provides a RESTful API for managing movies, TV shows, categories, and users. | ||
|
||
## Tech Stack | ||
|
||
![Node.js](https://img.shields.io/badge/-Node.js-339933?logo=node.js&logoColor=white) | ||
![Express](https://img.shields.io/badge/-Express-000000?logo=express&logoColor=white) | ||
![MongoDB](https://img.shields.io/badge/-MongoDB-47A248?logo=mongodb&logoColor=white) | ||
![Mongoose](https://img.shields.io/badge/-Mongoose-880000?logo=mongoose&logoColor=white) | ||
![JWT](https://img.shields.io/badge/-JWT-000000?logo=json-web-tokens&logoColor=white) | ||
![Joi](https://img.shields.io/badge/-Joi-F0DB4F?logo=joi&logoColor=black) | ||
![Bcrypt](https://img.shields.io/badge/-Bcrypt-2A7D7D?logo=bcrypt&logoColor=white) | ||
![Axios](https://img.shields.io/badge/-Axios-000000?logo=axios&logoColor=white) | ||
![Cors](https://img.shields.io/badge/-Cors-FFA07A?logo=cors&logoColor=white) | ||
![Dotenv](https://img.shields.io/badge/-Dotenv-000000?logo=dotenv&logoColor=white) | ||
![Swagger](https://img.shields.io/badge/-Swagger-85EA2D?logo=swagger&logoColor=black) | ||
|
||
## View the API Documentation | ||
|
||
The API documentation is available at [https://mern-movies-project-server.vercel.app/api/swagger/](https://mern-movies-project-server.vercel.app/api/swagger/). | ||
|
||
## Getting Started | ||
|
||
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. | ||
|
||
### Prerequisites | ||
|
||
- Node.js | ||
- npm | ||
|
||
### Installing | ||
|
||
Clone the repository: | ||
|
||
``` | ||
git clone https://github.com/thaoanhhaa1/MERN-Movies-Project-Server.git | ||
``` | ||
|
||
Install the dependencies: | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
Create a `.env` file in the root directory of the project and add your environment variables. | ||
|
||
Start the server: | ||
|
||
``` | ||
npm start | ||
``` | ||
|
||
## Contributing | ||
|
||
Please read `CONTRIBUTING.md` for details on our code of conduct, and the process for submitting pull requests to us. | ||
|
||
## License | ||
|
||
This project is licensed under the ISC License. | ||
|
||
## Acknowledgments | ||
|
||
Thanks to all contributors who participated in this project. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.