Updated Readme
This commit is contained in:
parent
b9b42c5ea7
commit
255a58c5c0
185
README.md
185
README.md
|
|
@ -1,179 +1,36 @@
|
|||
# Osu Spotify Yt Rest
|
||||
# Welcome to osu-spotify-yt-rest 👋
|
||||
|
||||
A RESTful API generated by [generator-rest](https://github.com/diegohaz/generator-rest).
|
||||
|
||||
[](#)
|
||||
[](https://twitter.com/BRAVO68WEB)
|
||||
|
||||
See the API's [documentation](DOCS.md).
|
||||
> Fetch Osu! Beatmaps from Spotify and Youtube Songs
|
||||
|
||||
## Commands
|
||||
## Install
|
||||
|
||||
After you generate your project, these commands are available in `package.json`.
|
||||
|
||||
```bash
|
||||
npm test # test using Jest
|
||||
npm run coverage # test and open the coverage report in the browser
|
||||
npm run lint # lint using ESLint
|
||||
npm run dev # run the API in development mode
|
||||
npm run prod # run the API in production mode
|
||||
npm run docs # generate API docs
|
||||
```sh
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Playing locally
|
||||
## Usage
|
||||
|
||||
First, you will need to install and run [MongoDB](https://www.mongodb.com/) in another terminal instance.
|
||||
|
||||
```bash
|
||||
$ mongod
|
||||
```sh
|
||||
yarn run start
|
||||
```
|
||||
|
||||
Then, run the server in development mode.
|
||||
## Author
|
||||
|
||||
```bash
|
||||
$ npm run dev
|
||||
Express server listening on http://0.0.0.0:9000, in development mode
|
||||
```
|
||||
👤 **BRAVO68WEB**
|
||||
|
||||
If you choose to generate the authentication API, you can start to play with it.
|
||||
> Note that creating and authenticating users needs a master key (which is defined in the `.env` file)
|
||||
- Website: https://bravo68web.me
|
||||
- Twitter: [@BRAVO68WEB](https://twitter.com/BRAVO68WEB)
|
||||
- Github: [@BRAVO68WEB](https://github.com/BRAVO68WEB)
|
||||
- LinkedIn: [@BRAVO68WEB](https://linkedin.com/in/BRAVO68WEB)
|
||||
|
||||
Create a user (sign up):
|
||||
```bash
|
||||
curl -X POST http://0.0.0.0:9000/users -i -d "email=test@example.com&password=123456&access_token=MASTER_KEY_HERE"
|
||||
```
|
||||
## Show your support
|
||||
|
||||
It will return something like:
|
||||
```bash
|
||||
HTTP/1.1 201 Created
|
||||
...
|
||||
{
|
||||
"id": "57d8160eabfa186c7887a8d3",
|
||||
"name": "test",
|
||||
"picture":"https://gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=identicon",
|
||||
"email": "test@example.com",
|
||||
"createdAt": "2016-09-13T15:06:54.633Z"
|
||||
}
|
||||
```
|
||||
Give a ⭐️ if this project helped you!
|
||||
|
||||
Authenticate the user (sign in):
|
||||
```bash
|
||||
curl -X POST http://0.0.0.0:9000/auth -i -u test@example.com:123456 -d "access_token=MASTER_KEY_HERE"
|
||||
```
|
||||
---
|
||||
|
||||
It will return something like:
|
||||
```bash
|
||||
HTTP/1.1 201 Created
|
||||
...
|
||||
{
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
|
||||
"user": {
|
||||
"id": "57d8160eabfa186c7887a8d3",
|
||||
"name": "test",
|
||||
"picture": "https://gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=identicon",
|
||||
"email": "test@example.com",
|
||||
"createdAt":"2016-09-13T15:06:54.633Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Now you can use the `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9` token (it's usually greater than this) to call user protected APIs. For example, you can create a new `article` API using `yo rest:api` and make the `POST /articles` endpoint only accessible to authenticated users. Then, to create a new article you must pass the `access_token` parameter.
|
||||
```bash
|
||||
curl -X POST http://0.0.0.0:9000/articles -i -d "title=Awesome Article&content=Yeah Baby&access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
|
||||
```
|
||||
|
||||
It will return something like:
|
||||
```bash
|
||||
HTTP/1.1 201 Created
|
||||
...
|
||||
{
|
||||
"id": "57d819bfabfa186c7887a8d6",
|
||||
"title": "Awesome Article",
|
||||
"content": "Yeah Baby",
|
||||
"createdAt": "2016-09-13T15:22:39.846Z",
|
||||
"updatedAt":"2016-09-13T15:22:39.846Z"
|
||||
}
|
||||
```
|
||||
|
||||
> Some endpoints are only accessible by admin users. To create an admin user, just pass the `role=admin` along to other data when calling `POST /users`.
|
||||
|
||||
## Deploy
|
||||
|
||||
Here is an example on how to deploy to [Heroku](https://heroku.com) using [Heroku CLI](https://devcenter.heroku.com/articles/heroku-command-line):
|
||||
```bash
|
||||
# start a new local git repository
|
||||
git init
|
||||
|
||||
# create a new heroku app
|
||||
heroku apps:create my-new-app
|
||||
|
||||
# add heroku remote reference to the local repository
|
||||
heroku git:remote --app my-new-app
|
||||
|
||||
# add the MongoLab addon to the heroku app
|
||||
heroku addons:create mongolab
|
||||
|
||||
# set the environment variables to the heroku app (see the .env file in root directory)
|
||||
heroku config:set MASTER_KEY=masterKey JWT_SECRET=jwtSecret
|
||||
|
||||
# commit and push the files
|
||||
git add -A
|
||||
git commit -m "Initial commit"
|
||||
git push heroku master
|
||||
|
||||
# open the deployed app in the browser
|
||||
heroku open
|
||||
```
|
||||
|
||||
The second time you deploy, you just need to:
|
||||
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "Update code"
|
||||
git push heroku master
|
||||
```
|
||||
|
||||
## Directory structure
|
||||
|
||||
### Overview
|
||||
|
||||
You can customize the `src` and `api` directories.
|
||||
|
||||
```
|
||||
src/
|
||||
├─ api/
|
||||
│ ├─ user/
|
||||
│ │ ├─ controller.js
|
||||
│ │ ├─ index.js
|
||||
│ │ ├─ index.test.js
|
||||
│ │ ├─ model.js
|
||||
│ │ └─ model.test.js
|
||||
│ └─ index.js
|
||||
├─ services/
|
||||
│ ├─ express/
|
||||
│ ├─ facebook/
|
||||
│ ├─ mongoose/
|
||||
│ ├─ passport/
|
||||
│ ├─ sendgrid/
|
||||
│ └─ your-service/
|
||||
├─ app.js
|
||||
├─ config.js
|
||||
└─ index.js
|
||||
```
|
||||
|
||||
### src/api/
|
||||
|
||||
Here is where the API endpoints are defined. Each API has its own folder.
|
||||
|
||||
#### src/api/some-endpoint/model.js
|
||||
|
||||
It defines the Mongoose schema and model for the API endpoint. Any changes to the data model should be done here.
|
||||
|
||||
#### src/api/some-endpoint/controller.js
|
||||
|
||||
This is the API controller file. It defines the main router middlewares which use the API model.
|
||||
|
||||
#### src/api/some-endpoint/index.js
|
||||
|
||||
This is the entry file of the API. It defines the routes using, along other middlewares (like session, validation etc.), the middlewares defined in the `some-endpoint.controller.js` file.
|
||||
|
||||
### services/
|
||||
|
||||
Here you can put `helpers`, `libraries` and other types of modules which you want to use in your APIs.
|
||||
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
|
||||
|
|
|
|||
Loading…
Reference in New Issue