{"id":13300790,"url":"https://github.com/kindlewit/esoteric-cerebrum","last_synced_at":"2025-03-10T12:32:54.441Z","repository":{"id":45098582,"uuid":"383856550","full_name":"kindlewit/esoteric-cerebrum","owner":"kindlewit","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-07T06:39:05.000Z","size":1273,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-03-07T07:42:34.273Z","etag":null,"topics":["fastify","hacktoberfest","postgresql"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kindlewit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2021-07-07T16:11:25.000Z","updated_at":"2022-10-26T06:59:01.000Z","dependencies_parsed_at":"2024-03-07T07:49:55.197Z","dependency_job_id":null,"html_url":"https://github.com/kindlewit/esoteric-cerebrum","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kindlewit%2Fesoteric-cerebrum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kindlewit%2Fesoteric-cerebrum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kindlewit%2Fesoteric-cerebrum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kindlewit%2Fesoteric-cerebrum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kindlewit","download_url":"https://codeload.github.com/kindlewit/esoteric-cerebrum/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242852026,"owners_count":20195757,"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":["fastify","hacktoberfest","postgresql"],"created_at":"2024-07-29T17:43:04.480Z","updated_at":"2025-03-10T12:32:53.807Z","avatar_url":"https://github.com/kindlewit.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"esoteric-cerebrum\n=\n\nThe backend system for kindlewit, a quizzing platform.\n\n## Tech Stack\n- DB : PostgreSql\n- Document DB : Elasticsearch\n- ORM : Sequelize\n- BE : NodeJS\n- API : Fastify\n- Caching : Redis\n- Logging: Elasticsearch\n\n## Installation\nYou will require [nodejs](https://nodejs.org/en/download/), [postgres](https://www.postgresql.org/download/), [elasticsearch](https://www.elastic.co/downloads/elasticsearch) and [redis](https://redis.io/download/) to run the server. Please install them as per your system. You could download them via docker.\n\n```\n# Install npm packages\nnpm install\n\n# Build the project\nnpm build\n\n# Start the API server\nnpm start\n```\n\n## Usage guide\n### Database\nLeave the default port for postgres (5432) as is.\nCreate a user: `username`, with password: `password` and a database: `thinq`.\n\n### In-memory cache\nLeave the default port for redis (6379) as is.\n\n### Log \u0026 Document database\nLeave the default ports for elasticsearch (9200, 9300) as is.\n\n### Running via docker\n`Dockerfile` \u0026 `docker-compose` are available at your disposal but currently do not work. This is due to a build script error which is being worked on actively.\n\nMeanwhile you can run the individual images as containers by the following commands.\n\u003cpre\u003e\n#Start redis container\ndocker run --name thinq-redis -p 6379:6379 -d redis:latest\u003cbr/\u003e\n#Start elasticsearch container\ndocker network create elastic\ndocker run --name thinq-elasticsearch --net elastic -e discovery.type=\"single-node\" -p 9200:9200 -p 9300:9300 -d elasticsearch:7.17.2\n\u003c/pre\u003e\n\n## Folder structure\n\n\u003cpre\u003e\n.\n|   Config and init files happen here\n|\n|---.github\n|   |--- workflows\n|     |-- Github workflows happen here\n|\n|---.vscode\n|   |-- VS code settings happen here\n|\n|---src\n|   |---handlers\n|   |   |--- API handler functions happen here\n|   |\n|   |---models\n|   |   |--- DB models happen here\n|   |\n|   |---routes\n|   |   |--- API routing happens here\n|   |\n|   |---services\n|   |   |--- DB services happen here\n|   |\n|   |---utils\n|   |   |--- Utility functions happen here\n|\n|---tests\n|   |---constants.js\n|   |---raw_data.js\n|   |---README.md\n|   |---stress.js\n|   |\n|   |---simple\n|   |   |--- Test files happens here\n|\n|---words\n\u003c/pre\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkindlewit%2Fesoteric-cerebrum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkindlewit%2Fesoteric-cerebrum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkindlewit%2Fesoteric-cerebrum/lists"}