Skip to content

Commit c2dbe4c

Browse files
feat: Adds docs
1 parent 636cf4a commit c2dbe4c

File tree

124 files changed

+53471
-5642
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+53471
-5642
lines changed

.dockerignore

Lines changed: 0 additions & 4 deletions
This file was deleted.

.env.sample

Lines changed: 0 additions & 8 deletions
This file was deleted.

.github/workflows/node.js.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

.gitignore

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ bower_components
3030
.lock-wscript
3131

3232
# Compiled binary addons (https://nodejs.org/api/addons.html)
33-
build/Release
33+
build/
3434

3535
# Dependency directories
3636
node_modules/
@@ -60,4 +60,12 @@ typings/
6060
# next.js build output
6161
.next
6262

63-
dist
63+
dist
64+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
65+
66+
# dependencies
67+
/.pnp
68+
.pnp.js
69+
70+
# misc
71+
.DS_Store

.vscode/settings.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

Dockerfile

Lines changed: 0 additions & 9 deletions
This file was deleted.

Dockerfile.bak

Lines changed: 0 additions & 64 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,11 @@
1-
# Open Song Database API [![Build Status](https://github.com/cokoghenun/open-song-database-api/workflows/build/badge.svg)](https://github.com/cokoghenun/open-song-database-api/actions?query=workflow%3A%22build%22)
1+
# Open Song Database
22

3-
Welcome to the Open Song Database API.<br >
4-
Front-end repo is [here](https://github.com/cokoghenun/open-song-database)
3+
Welcome to the Open Song Database <br >
54

65
## Contributions
76

87
Your contributions are highly welcomed.
98

10-
## Docs
11-
12-
The documentation of this API can be found at [https://osdbapi.com](https://osdbapi.com/docs/)
13-
14-
## Scripts
15-
16-
In the project directory, you can run:
17-
18-
### `yarn dev`
19-
20-
Runs the app in the development mode on port `4000`.<br />
21-
`REST` endpoint is at `http://localhost:4000/rest/<your-api-key>/`.<br />
22-
Open `http://localhost:4000/graphql/<your-api-key>/` to view GraphiQL the browser.
23-
24-
### `yarn build`
25-
26-
Builds the app for production to the `dist/` folder.<br />
27-
It correctly transpiles the project in production mode and optimizes the build for the best performance.
28-
299
## Road Map
3010

3111
This is the roadmap of the project for the foreseeable future:
File renamed without changes.

api/.dockerignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.env
2+
dist/
3+
node_modules/

0 commit comments

Comments
 (0)