nusmodifications / nusmodifications/nusmods
[Feature] API server using Node
Open
Nobody has claimed this yet.
api
- Dominant language
- JavaScript
- Stars
- 689
- Forks
- 364
- Avg merge
- 7h 5m
- Merged PRs (30d)
- 14
Description
As dictated by the progenitor @yangshun (and through much discussion) I think we might still go with node.
To summarize, the benefits are
- Newcomers know Javascript, courtesy of CS1101S
- Our entire stack is already Javascript
- We may be able to share code
The cons are
- More code to write
Thankfully, I don't think there's too much code. The following are steps needed to get out api mvp out:
- Remove previous data code that reads files #1105
- Upgrade to apollo-server 2 #1107
- Add new schemas for a fully functional server #1111
- Add queries to fetch data from db #1151
- Add mutations to add data from db
- Add validations to mutations
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing Node API server, the Apollo Server 2 setup, and the completed schemas. The remaining checklist covers database queries, mutations, and mutation validation; done means these items are implemented and the API can fetch and add data safely.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- graphql, javascript, node.js
- Domain
- api, backend, databases
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100