Be sure to read all of this document carefully, and follow the guidelines within.
Build a RESTful API that can create/read/update/delete user data from a persistence store.
{
"id": "xxx", // user ID (must be unique)
"name": "backend test", // user name
"dob": "", // date of birth
"address": "", // user address
"description": "", // user description
"createdAt": "" // user created date
"updatedAt": "" // user updated date
}
- The API should follow typical RESTful API design pattern.
- The data should be saved in the DB.
- Provide proper API documentation.
- Proper error handling should be used.
Use any libraries that you would normally use if this were a real production App. Please note: we're interested in your code & the way you solve the problem, not how well you can use a particular library or feature.
We're interested in your method and how you approach the problem just as much as we're interested in the end result.
Here's what you should strive for:
- Good use of current Node.js & Express.js
- Good use of API design best practices.
- Solid testing approach.
- Extensible code.
- Use Node.js
LTSand any framework of your choice. - Use any SQL DB. MySQL DB is preferred.
- Write concise and clear commit messages.
- Write clear documentation on how it has been designed and how to run the code.
- Use typescript.
- Use of Sequelize ORM (https://sequelize.org/)
- Provide proper unit tests.
- Add a read only endpoint to fetch location information based off the user's address (use NASA or Mapbox APIs)
- Providing an online demo is welcomed, but not required.
Where should I send back the result when I'm done?
Fork this repo and send us a pull request when you think you are done. Or send me the link of the forked repo.
What if I have a question?
Create a new issue in this repo or send me an email.