{"id":23270264,"url":"https://github.com/nxdun/timetide","last_synced_at":"2025-04-06T09:40:35.689Z","repository":{"id":234389865,"uuid":"788796426","full_name":"nxdun/timetide","owner":"nxdun","description":"Generates University timetable in weekly basis with Lecturer,Hall,Course,Resources Management","archived":false,"fork":false,"pushed_at":"2024-05-04T15:04:17.000Z","size":1136,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T15:18:56.502Z","etag":null,"topics":["documentation","react","security","testing"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nxdun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-19T05:21:02.000Z","updated_at":"2024-07-02T15:42:39.000Z","dependencies_parsed_at":"2024-04-19T06:27:53.188Z","dependency_job_id":"6a562f52-48f6-48d3-990a-62bd01438d8c","html_url":"https://github.com/nxdun/timetide","commit_stats":null,"previous_names":["nxdun/timetide"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nxdun%2Ftimetide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nxdun%2Ftimetide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nxdun%2Ftimetide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nxdun%2Ftimetide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nxdun","download_url":"https://codeload.github.com/nxdun/timetide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247463805,"owners_count":20942940,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","react","security","testing"],"created_at":"2024-12-19T18:49:16.041Z","updated_at":"2025-04-06T09:40:35.653Z","avatar_url":"https://github.com/nxdun.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n#  🧭TimeTide \n\n\n⭐ [Link to API Documentation](https://documenter.getpostman.com/view/28802704/2sA35BbPtc)\u003c/br\u003e\n⭐ [Link to all diagrams](https://rentry.co/diagramsforaf)\u003c/br\u003e\n⭐ [security test results](https://rentry.co/burptestresults)\n\n## Table of Contents\n\n- [🧭TimeTide](#timetide)\n  - [Table of Contents](#table-of-contents)\n  - [Description](#description)\n  - [Installation](#installation)\n  - [How-to-Run-Tests](#how-to-run-tests)\n  - [Setting-enviroment-variables](#setting-enviroment-variables)\n  - [Usage](#usage)\n  - [Problems-Faced](#problems-faced)\n  - [Security-Test](#security-test)\n  - [License](#license)\n  - [Contact](#contact)\n## Description\n\nTimeTide is a backend API designed for seamlessly managing university timetables. It provides\n- Endpoints for CRUD operations on various resources related to timetables\n- Endpoints for user authentication operations\n- Endpoints for generating services related to timetables\n- Endpoint for Notification handler\n...\n\n## Installation\n\nTo install TimeTide, follow these steps:\n\n1. Clone the repository from GitHub.\n2. Navigate to the project directory.\n3. Install dependencies using `npm install`.\n4. Set up environment variables in a `.env` file (Place .env File On Backend Folder)\n5. Start the server using `npm run dev`(Path:backend).\n\n## How-to-Run-Tests\n- Clone the repository from GitHub\n- `cd backend`:go to Backend folder\n- Create `.env` File in there  and set all enviroment variables\n- `npm install `:install all packages (Testing libraries are on Developement dependacies)\n-  `npm run test1 `:Runs all Unit Tests\n-  `npm run test2 `:Runs all Unit + Intergration Tests\n\n## Setting-enviroment-variables\n\n- `PORT`: (Specify the port number your server will run on)\n- `MONGOSTRING`: \"mongodb+srv:// \"\n- `JWT_SECRET`: (Specify your JWT secret key)\n- `ADMIN_USERNAME`: (Specify admin username)(only for First time use)\n\t-  Refer `POST : /v1/auth/register` in [📖 Documentation ](https://documenter.getpostman.com/view/28802704/2sA35BbPtc)\n\t- remove this enviroment varaible after use\n\t- you can have many admins but specify them like this first to add another admin\n- `ADMIN_PASSWORD`: (Specify admin password)(onlyfor First time use)\n\n\n## Usage\n\nAfter installation, you can use the following endpoints:\n\nPOSTMAN BACKEND DOCUMENTATION : [Link to Postman Backend Documentation]([\u003e\u003e](https://documenter.getpostman.com/view/28802704/2sA35BbPtc)) \n\n- 🔒`/v1/api`: Endpoints for CRUD operations on timetables and related resources.\n- 🔓`/v1/auth`: Endpoints for user authentication operations.\n- 🔒`/v1/generate`: Endpoints for generating services related to timetables.\n- 🔒`/v1/notifications`: Endpoints for handling notifications.\n\nEnsure you have proper authentication tokens to access protected endpoints.\n\n\n## Problems-Faced\n\nProblems that have been addressed:\n\n1. MongoDB schema designing: circular reference between tables(Booking and Courses)\u003c/br\u003e\n\t\tFIX: Removed Object Refereence From Courses (Not Required, Easily recreated Project Thanks to loosely Coupled design)\n2. Chai-http wont Run on Common js module\u003c/br\u003e\n\t\tFIX: Used supertest For Intergration Testing\n\n\n## Security-Test\n\nUsed Burp Suite to Check Security vulnerability\n- Found out TimeTide is vulnerable for XSS attacks\u003c/br\u003e\nFIX:\n\t- `npm install helmet` : installed helmet npm package and set important security headers \"`X-XSS-Protection: 1; mode=block`,`X-Content-Type-Options: nosniff`, `Strict-Transport-Security: max-age=63072000; includeSubDomain`...)\n- Found out TimeTide is vulnerable for DOS attacks\u003c/br\u003e\nFIX:\n\t- `npm install express-rate-limit` : installed express rate limiter package and limited , this rate limiter configuration allows up to `100` requests per IP address every `15` minutes. If a client exceeds this limit, they will receive a \"Service Unavailable\" response\n\n\n## License\n\nTimeTide is licensed under the ISC License. See [LICENSE](LICENSE) for more information.\n\n## Contact\n\nFor any inquiries or assistance, feel free to contact the project maintainer:\n\n- Name: Lakshan S N\n- Email: [inbox.nadun@gmail.com](mailto:inbox.nadun@gmail.com)\n- GitHub: [github.com/nxdun](https://github.com/nxdun)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnxdun%2Ftimetide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnxdun%2Ftimetide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnxdun%2Ftimetide/lists"}