You should have a MongoDB instance. Either using basic installation, cloud, or Docker.
We might migrate to other database solution in the future.
You should retrieve the Mailgun API key from your own account during development.
Install using yarn instead of npm:
yarnThis will automatically create .env file during postinstall.
Edit the .env file:
PLATFORM_API_KEY=a_secret_text
DOMAIN_URL=http://localhost:8000
MONGODB_URI=mongodb://localhost:27017/highskillmasters-api
MAILGUN_API_KEY=abcdefghijklmnopqrstu
MAILGUN_DOMAIN=mg.example.com
EMAIL_DEFAULT_FROM=Name <name@example.com>
EMAIL_DEFAULT_TO=name+other@example.com
Before going further, you should also clone the web repo and web admin repo, then run the development server of React of each. So you can understand what's really needed in the client-side.
yarn devThen you can send a request to http://localhost:3000 on your browser or API client.
For now, we're focusing on improving the data, endpoint, and fixing issues.
Do let us know by creating a new issue or sending a pull request.
| Endpoints | Method | Description | Headers | Query | Body |
|---|---|---|---|---|---|
/ |
GET | Hello message | - | - | - |
/auth |
GET | Get auth index | - | - | - |
/auth/login |
GET | Login as admin | Authorization |
api_key |
- |
/members |
GET | Get all members | Authorization |
api_key |
- |
/members/subscribe |
POST | Subscribe new member | - | - | email |
/members/unsubscribe |
POST | Unsubscribe member | - | - | email |
/members/verify |
GET | Verify member email | - | email, code |
- |
/tokens |
GET | Get all tokens | Authorization |
api_key |
- |