noteely is a note-taking and sharing application. noteely makes it easy to take notes during a class, lecture or meeting and sharing them with peers.
notely is a note taking and sharing application. This application for not production grade and backend only (for now). This project is a child of the technical assessment challenge by speer.io for Backend Role. More details can be found here: Link to challenge
Yet to be updated
You have been asked to build a secure and scalable RESTful API that allows users to create, read, update, and delete notes. The application should also allow users to share their notes with other users and search for notes based on keywords.
- Implement a RESTful API using a framework of your choice (e.g. Express, DRF, Spring).
- Use a database of your choice to store the data (preferably MongoDB or PostgreSQL).
- Use any authentication protocol and implement a simple rate limiting and request throttling to handle high traffic.
- Implement search functionality to enable users to search for notes based on keywords. ( preferably text indexing for high performance )
- Write unit tests and integration tests your API endpoints using a testing framework of your choice.
Your API should implement the following endpoints:
- Authentication Endpoints
POST /api/auth/signup: create a new user account.POST /api/auth/login: log in to an existing user account and receive an access token.
- Note Endpoints
GET /api/notes: get a list of all notes for the authenticated user.GET /api/notes/:id: get a note by ID for the authenticated user.POST /api/notes: create a new note for the authenticated user.PUT /api/notes/:id: update an existing note by ID for the authenticated user.DELETE /api/notes/:id: delete a note by ID for the authenticated user.POST /api/notes/:id/share: share a note with another user for the authenticated user.GET /api/search?q=:query: search for notes based on keywords for the authenticated user.
- A GitHub repository with your code.
- A README file
- Details explaining the choice of framework/db/ any 3rd party tools.
- instructions on how to run your code and run the tests.
- Any necessary setup files or scripts to run your code locally or in a test environment.
Your code will be evaluated on the following criteria:
- Correctness: does the code meet the requirements and work as expected?
- Performance: does the code use rate limiting and request throttling to handle high traffic?
- Security: does the code implement secure authentication and authorization mechanisms?
- Quality: is the code well-organized, maintainable, and easy to understand?
- Completeness: does the code include unit, integration, and end-to-end tests for all endpoints?
- Search Functionality: does the code implement text indexing and search functionality to enable users to search for notes based on keywords?
- Java (21)
- Spring/SpringBoot (3.x)
- Test Containers (for integration testing)
- MongoDB
- I like my type system to complain before application runs in production, so choice is either Java or Go.
- More familiar with Java and its ecosystem, so the choice of Java.
- SpringBoot - cause its the go to web framework for Java web development, and I am more familiar with this
- MongoDB - Reason is two fold: Mongo supports Text Indexing for faster searches, which will help in the requirement and horizontally scalable. Secondly, never uses a nosql DB, so a good chance to learn.
- Test Container - Docker is the best thing till now, and test containers just makes it easy to work with integration test, also run multiple TCs parallely with multiple containers.
- username/password storing is the last thing to do in this era, we should rely on providers. For sake of this problem, we are giving an option for custom email/password signin.
All source code is released under MIT LICENSE, a copy of which can be found here.