https://github.com/helloyeew/mamizu-api
My personal API to make and develop some personal stuff easier
https://github.com/helloyeew/mamizu-api
Last synced: about 1 year ago
JSON representation
My personal API to make and develop some personal stuff easier
- Host: GitHub
- URL: https://github.com/helloyeew/mamizu-api
- Owner: HelloYeew
- License: mit
- Created: 2022-01-23T11:45:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-23T08:00:14.000Z (about 3 years ago)
- Last Synced: 2025-02-12T00:46:23.600Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 584 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mamizu-api
My personal API to make and develop some personal stuff easier
## Purpost of this project
I want to make my personal API as I want to explore more framework and this API is about my personal project.
So why just not make a API for my personal project? That's it.
## Development status
The development progress is slow because I have a lot of IRL stuff but the GET response is finish.
## Why this name?
I put this API beside [mamizu](https://github.com/HelloYeew/mamizu) because I don't want to pay more server fee.
## TODO List
- [ ] CRUD operations
- [ ] Can manage CRUD operation on site
- [ ] Documentations
- [ ] Convert to database
- [ ] Convert to TypeScript
## Documentation
*Coming soon*
## Setup the project
Clone this repository to your local machine.
```shell
git clone https://github.com/HelloYeew/mamizu-api
```
Install dependencies.
```shell
npm install
```
Create the new `.env` file for configuration.
```dotenv
PORT=3000 # Port number
DEBUG=true # Debug mode
```
Start the development server
```shell
npm run dev # for linux or MacOS
npm run dev-win # for Windows
```
And the server will run on your target port.
Note : On development server it will use nodemon to run the server for easier debugging since it will restart the server when there is any change.