Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mymicds/mymicds-v2
Back-end REST API for MyMICDS.net
https://github.com/mymicds/mymicds-v2
express micds mymicds nodejs rest-api
Last synced: about 2 months ago
JSON representation
Back-end REST API for MyMICDS.net
- Host: GitHub
- URL: https://github.com/mymicds/mymicds-v2
- Owner: MyMICDS
- License: agpl-3.0
- Created: 2016-02-09T22:51:34.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-21T06:16:23.000Z (over 1 year ago)
- Last Synced: 2024-04-09T12:29:10.593Z (9 months ago)
- Topics: express, micds, mymicds, nodejs, rest-api
- Language: TypeScript
- Homepage: https://mymicds.net
- Size: 19.6 MB
- Stars: 8
- Watchers: 6
- Forks: 5
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MyMICDS-v2
MyMICDS.net for all of your MyMICDS.needs## Setup
### Dependencies
To start development on MyMICDS-v2, first run `npm install` in the main project directory.
This will install all the runtime dependencies (including TypeScript) as well as TypeDoc, TSLint, and all the other development dependencies.### Configuration
A local config file is required on every machine you develop on. This stores sensitive information such as database credentials and API keys.
Copy `src/libs/config.example.ts` into a new file called `config.ts` with the proper information filled out as described in the example.
This file is included in `.gitignore`, so you don't have to worry about accidentally committing the credentials.### Usage
To start the server for development, run `npm start`. In a production environment, run `npm run prod`.#### Tasks Server
To start the tasks server, run `npm run tasks`.#### For Development
If you would like the server to restart on file changes, install [`nodemon`](https://nodemon.io/) and simply run `nodemon` in the project root.### Documentation
Run `npm run docs` to build documentation. TypeDoc will generate documentation based on comments and type structures and dump it into the `/docs/` folder.
This creates static HTML files, so you'll have to open them manually in your browser.### Testing
Run `npm test` to do a compilation check on all source files and run the API tests.
Similar to `src/libs/config.ts`, the tests require a `test/config.ts` that needs to be filled out.**Note:** When adding new routes to the API, contributors should always add a corresponding test,
unless there are factors (performance, authentication, etc) that would make it unreasonable to run the test quickly on a CI server.## Other Repositories
### [MyMICDS-v2-Angular](https://github.com/MyMICDS/MyMICDS-v2-Angular)
The Angular front-end for MyMICDS.### [MyMICDS-SDK](https://github.com/MyMICDS/MyMICDS-SDK)
The official TypeScript client for connecting to MyMICDS. Automatically handles API requests using RxJS.### [MyMICDS-WatchFace](https://github.com/MyMICDS/MyMICDS-WatchFace)
A Wear OS watch face featuring MyMICDS integration.## Contact
Wanna become a developer on the MyMICDS.net team? Shoot us an email at [[email protected]](mailto:[email protected])!
We accept anyone and everyone, so don't be shy!For any other questions, comments, concerns, or suggestions, you can also contact [email protected].