https://github.com/stantanasi/mangajap-api
API server for MangaJap
https://github.com/stantanasi/mangajap-api
api json-api mangajap mongodb mongoose node-js nodejs typescript
Last synced: about 2 months ago
JSON representation
API server for MangaJap
- Host: GitHub
- URL: https://github.com/stantanasi/mangajap-api
- Owner: stantanasi
- License: apache-2.0
- Created: 2021-09-13T13:27:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-04T20:14:58.000Z (2 months ago)
- Last Synced: 2025-03-04T20:23:40.068Z (2 months ago)
- Topics: api, json-api, mangajap, mongodb, mongoose, node-js, nodejs, typescript
- Language: TypeScript
- Homepage: https://documenter.getpostman.com/view/10400618/2s9YeN3ora
- Size: 1.05 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
MangaJap: API
MangaJap is an app that lets you organize yourself among all the manga and anime you love.
View API Docs »
Report Bug
·
Request Feature
Table of Contents
- [About the project](#about-the-project)
- [Features](#features)
- [Built with](#built-with)
- [Getting started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Development](#development)
- [Contributing](#contributing)
- [Author](#author)
- [License](#license)
## About the project
MangaJap is a modern platform that helps you track the anime you're watching and the manga you're reading.
With the MangaJap API you can do everything the client can do and much more.
### Features
- 100% free and no ads!
- An enormous collection of manga and anime.
### Built with
- [Node.js](https://nodejs.org)
- [TypeScript](https://www.typescriptlang.org)
- [MongoDB](https://www.mongodb.com)
- [JSON:API](https://jsonapi.org)
## Getting started
### Prerequisites
- Install [Node.js](https://nodejs.org) which includes [Node Package Manager](https://www.npmjs.com/get-npm)
### Setup
1. Clone the project to your local machine
```bash
git clone https://github.com/mangajap/mangajap-api.git
```
2. Install the packages required
```bash
npm install
```
## Development
Run the application
```bash
npm run start:dev
```
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the project
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'feat: add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a pull request
## Author
- [Lory-Stan TANASI](https://github.com/stantanasi)
## License
This project is licensed under the `Apache-2.0` License - see the [LICENSE](LICENSE) file for details
© 2021 Lory-Stan TANASI. All rights reserved