Secret note (API/SPA)- Mariam Mahrous - Githubissues

codescalersinternships / home

home repo for internships

4 stars 0 forks source link

Secret note (API/SPA)- Mariam Mahrous #232

Open mariammahrous23 opened 4 months ago

mariammahrous23 commented 4 months ago

Secret Note Sharing Application

Create a web application that allows users to securely share self-destructing secret notes.

Requirements: Note Creation:

[x] Users can create a note with text content
[x] Generate a unique, secure URL for each note
[x] Set an expiration time or number of views before destruction

Note Retrieval:

[x] Users can view a note using the unique URL
[x] After viewing or upon expiration, the note is permanently deleted

Security Features:

[x] Use secure random generation for URLs (i should be able to browse /note/1, /note/2, .. etc the urls shouldn't be predictable

Backend:

[x] Swagger docs for the API
[x] Develop a restful API using Go
[x] Use a database (e.g., sqlite or postgresql) for storing the notes

Frontend:

[x] Create a simple, responsive UI using Vue

Authentication:

[ ] Implement rate limiting to prevent abuse

Testing:

[ ] Write unit and integration tests for the backend
[x] Postman collections for testing
[ ] Implement end-to-end tests for critical user flows

Deployment:

[x] Containerize the application using Docker
[x] Create a docker-compose file for easy local deployment

Optional

[ ] Encrypting the notes in the database

Acceptance Criteria:

[x] Notes can be securely created, shared, and destroyed
[x] Docker deployment works as expected