{"id":28273425,"url":"https://github.com/fbn776/scrinix-be","last_synced_at":"2026-04-15T14:31:23.318Z","repository":{"id":271777224,"uuid":"881494892","full_name":"fbn776/Scrinix-BE","owner":"fbn776","description":"Scrinix: A web app for efficient internal exam moderation with role-based access for coordinators and faculty, built with Next.js, Node.js, and PostgreSQL.","archived":false,"fork":false,"pushed_at":"2025-01-09T19:54:44.000Z","size":535,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-07T18:28:45.500Z","etag":null,"topics":["backend","express","ktu","management-systems","microproject","nodejs","postgresql","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/fbn776.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-10-31T17:26:10.000Z","updated_at":"2025-01-09T20:02:59.000Z","dependencies_parsed_at":"2025-01-09T20:40:24.159Z","dependency_job_id":null,"html_url":"https://github.com/fbn776/Scrinix-BE","commit_stats":null,"previous_names":["fbn776/scrinix-be"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fbn776/Scrinix-BE","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbn776%2FScrinix-BE","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbn776%2FScrinix-BE/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbn776%2FScrinix-BE/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbn776%2FScrinix-BE/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fbn776","download_url":"https://codeload.github.com/fbn776/Scrinix-BE/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbn776%2FScrinix-BE/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31845488,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T13:28:40.153Z","status":"ssl_error","status_checked_at":"2026-04-15T13:28:29.396Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["backend","express","ktu","management-systems","microproject","nodejs","postgresql","typescript"],"created_at":"2025-05-21T00:18:13.223Z","updated_at":"2026-04-15T14:31:23.299Z","avatar_url":"https://github.com/fbn776.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scrinix-backend\nWelcome to the backend of Scrinix, a platform designed to streamline the moderation of internal exams.\nThis documentation outlines the key aspects, features, and structure of the backend system, built to provide a secure and efficient foundation for the application.\n\n\u003e **Note**: The application is not completed. Feel free to contribute or fork this project.\n\n## **Frontend Repository**\nThe frontend repository can be found [here](https://github.com/fbn776/Scrinix-FE).\n\n## **Tech Stack**\n- **Runtime**: Node.js\n- **Framework**: Express.js\n- **Database**: PostgreSQL\n- **File Uploads**: Multer (stored in postgres)\n\n---\n\n## **Project Structure**\n```plaintext\n└── Scrinix-BE/\n    ├── README.md\n    ├── package.json\n    ├── tsconfig.json\n    ├── .swcrc\n    ├── docs/\n    │   ├── README.md\n    │   ├── DB.md\n    │   ├── File structure.md\n    │   ├── Private.md\n    │   ├── TODO.md\n    │   └── assets/\n    ├── init/\n    │   ├── basic_insertions.sql\n    │   ├── cleanup.sql\n    │   └── schema.sql\n    └── src/\n        ├── index.ts\n        ├── config/\n        │   └── db.ts\n        ├── controllers/\n        │   └── admin/\n        │       └── root.ts\n        ├── lib/\n        │   ├── ErrorHandling.ts\n        │   ├── HTTP_status.ts\n        │   ├── Logger.ts\n        │   ├── hashPassword.ts\n        │   └── utils.ts\n        ├── models/\n        │   ├── type.d.ts\n        │   ├── college/\n        │   │   └── model.ts\n        │   └── faculty/\n        │       └── model.ts\n        └── routes/\n            ├── swagger.ts\n            ├── admin/\n            │   ├── clgAdmin.ts\n            │   ├── index.ts\n            │   └── root.ts\n            ├── coordinator/\n            │   └── index.ts\n            ├── course/\n            │   └── index.ts\n            ├── exams/\n            │   └── index.ts\n            └── staff/\n                └── index.ts\n```\n\n## Usage\n### Development\n\n1. Clone the repository\n2. Install the dependencies.\n    ```bash\n    npm install\n   # or\n    yarn install\n    # or\n    pnpm install\n    ```\n3. Create a `.env` file and populate it with the following environment variables.\n    ```dotenv\n    PORT=3000\n    DB_USER=\n    DB_HOST=\n    DB_NAME=\n    DB_PASSWORD=\n    ```\n4. Start the development server.\n    ```bash\n    npm run dev\n    # or\n    yarn dev\n    # or\n    pnpm dev\n    ```\n5. The server would be running at [http://localhost:3000](http://localhost:3000) locally.\n\n### Production\n\n1. Clone the repository and install the dependencies and follow the above mentioned steps upto step 3.\n2. Build the project.\n    ```bash\n    npm run build\n    # or\n    yarn build\n    # or\n    pnpm build\n    ```\n3. Start the production server.\n    ```bash\n    npm start\n    # or\n    yarn start\n    # or\n    pnpm start\n    ```\n\n### Database\n\nThe project uses postgres SQL as the database. \nFor creating the scheme run the [schema](./init/schema.sql) file in the database.\nFor cleaning up the scheme run the [cleanup](./init/cleanup.sql) file in the database.\n\n### API Documentation\n\nThe API documentation is available at [http://localhost:5000/api-docs](http://localhost:3000/api-docs) when the server is running.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffbn776%2Fscrinix-be","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffbn776%2Fscrinix-be","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffbn776%2Fscrinix-be/lists"}