Merge branch 'JuniorDark:master' into master
This commit is contained in:
commit
8ae0597aeb
2 changed files with 6 additions and 22 deletions
24
README.md
24
README.md
|
|
@ -5,6 +5,10 @@ RustyHearts-API is a Node.js-based REST API that enables authentication, billing
|
||||||
|
|
||||||
The API consists of three independent servers (Auth API, Billing API and Launcher API) running on different ports.
|
The API consists of three independent servers (Auth API, Billing API and Launcher API) running on different ports.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Either use `git clone https://github.com/JuniorDark/RustyHearts-API` on the command line to clone the repository or use Code --> Download zip button to get the files.
|
||||||
|
|
||||||
### Preview
|
### Preview
|
||||||

|

|
||||||
|
|
||||||
|
|
@ -28,9 +32,6 @@ The api currently only support the **usa** (PWE) region.
|
||||||
* [.env file setup](#env-file-setup)
|
* [.env file setup](#env-file-setup)
|
||||||
* [Available endpoints](#available-endpoints)
|
* [Available endpoints](#available-endpoints)
|
||||||
* [License](#license)
|
* [License](#license)
|
||||||
* [Contributing](#contributing)
|
|
||||||
* [FAQ](#faq)
|
|
||||||
* [Support](#support)
|
|
||||||
|
|
||||||
## Public folder description
|
## Public folder description
|
||||||
|
|
||||||
|
|
@ -136,20 +137,3 @@ Endpoint | Method | Arguments | Description
|
||||||
|
|
||||||
## License
|
## License
|
||||||
This project is licensed under the terms found in [`LICENSE-0BSD`](LICENSE).
|
This project is licensed under the terms found in [`LICENSE-0BSD`](LICENSE).
|
||||||
|
|
||||||
## Contributing
|
|
||||||
Contributions from the community are welcome! If you encounter a bug or have a feature request, please submit an issue on GitHub. If you would like to contribute code, please fork the repository and submit a pull request.
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
* Q: How do I report a bug?
|
|
||||||
* A: Please submit an issue on GitHub with a detailed description of the bug and steps to reproduce it.
|
|
||||||
* Q: How do I request a new feature?
|
|
||||||
* A: Please submit an issue on GitHub with a detailed description of the feature and why it would be useful.
|
|
||||||
* Q: How do I contribute code?
|
|
||||||
* A: Please fork the repository, make your changes, and submit a pull request.
|
|
||||||
|
|
||||||
## Support
|
|
||||||
If you need help with the api, please submit an issue on GitHub.
|
|
||||||
|
|
||||||
## Roadmap
|
|
||||||
* Add support for other regions
|
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,7 @@
|
||||||
"url": "https://github.com/JuniorDark/RustyHearts-API/issues"
|
"url": "https://github.com/JuniorDark/RustyHearts-API/issues"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"bcryptjs": "^2.4.3",
|
"bcryptjs": "^3.0.2",
|
||||||
"compression": "^1.7.4",
|
"compression": "^1.7.4",
|
||||||
"cors": "^2.8.5",
|
"cors": "^2.8.5",
|
||||||
"dotenv": "^16.0.3",
|
"dotenv": "^16.0.3",
|
||||||
|
|
@ -30,7 +30,7 @@
|
||||||
"express-validator": "^7.0.1",
|
"express-validator": "^7.0.1",
|
||||||
"express-winston": "^4.2.0",
|
"express-winston": "^4.2.0",
|
||||||
"handlebars": "^4.7.7",
|
"handlebars": "^4.7.7",
|
||||||
"helmet": "^7.0.0",
|
"helmet": "^8.0.0",
|
||||||
"joi": "^17.9.2",
|
"joi": "^17.9.2",
|
||||||
"logger": "^0.0.1",
|
"logger": "^0.0.1",
|
||||||
"moment-timezone": "^0.5.43",
|
"moment-timezone": "^0.5.43",
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue