Skip to content

Commit a533790

Browse files
author
Soundcloud (BookishWaffle)
committed
pls
1 parent 8912bc8 commit a533790

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

Diff for: .gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/settings/config.json

Diff for: README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Soundcloud Desktop API
2+
This is the official API for the Soundcloud Desktop application.
3+
4+
# Notable Features
5+
- Returns a list of verified artists.
6+
- Returns a list of service developers.
7+
- Returns a list of service contributors.
8+
- Returns a list of client uptime.
9+
10+
# Installation
11+
- Install the [Git Client](https://git-scm.com/) on your machine.
12+
- Install [Node.js](https://nodejs.org/) on your machine.
13+
- Open a brand new terminal and run `git clone https://github.com/soundcloud-py/client-api`.
14+
- Navigate to the brand new directory. It should be named `client-api`.
15+
- Run the `npm install` command.
16+
- Once the installation is finished, run `node server.js` and the API should start.
17+
18+
# Example
19+
- To return the service developers: `http://localhost:3000/api/developers/`
20+
- To return the service contributors: `http://localhost:3000/api/contributors/`
21+
22+
# FAQ
23+
**How come this is made in JavaScript and not Python?** Because, I don't know Python.
24+
**How come this exists?** This is just a last minute project so I'm not sure.
25+
26+
# Developers
27+
Without the people listed below, this project wouldn't exist.
28+
29+
- [BookishWaffle](https://github.com/BookishWaffle/)

0 commit comments

Comments
 (0)