{"id":18843622,"url":"https://github.com/adarshaacharya/csoverflow","last_synced_at":"2025-04-14T07:32:31.469Z","repository":{"id":49124472,"uuid":"304051998","full_name":"adarshaacharya/CsOverflow","owner":"adarshaacharya","description":"Q/A forum for Computer Science and Engineering students.","archived":false,"fork":false,"pushed_at":"2021-08-27T15:10:04.000Z","size":1123,"stargazers_count":14,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T21:38:41.942Z","etag":null,"topics":["antd","csoverflow","mern","nodejs","reactjs","redux","sequelize"],"latest_commit_sha":null,"homepage":"https://csoverflow.herokuapp.com/","language":"TypeScript","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/adarshaacharya.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-14T15:08:20.000Z","updated_at":"2024-03-03T10:01:23.000Z","dependencies_parsed_at":"2022-09-05T03:00:34.801Z","dependency_job_id":null,"html_url":"https://github.com/adarshaacharya/CsOverflow","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adarshaacharya%2FCsOverflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adarshaacharya%2FCsOverflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adarshaacharya%2FCsOverflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adarshaacharya%2FCsOverflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adarshaacharya","download_url":"https://codeload.github.com/adarshaacharya/CsOverflow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248839549,"owners_count":21169829,"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":["antd","csoverflow","mern","nodejs","reactjs","redux","sequelize"],"created_at":"2024-11-08T02:58:24.970Z","updated_at":"2025-04-14T07:32:30.608Z","avatar_url":"https://github.com/adarshaacharya.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003ca href=\"https://csoverflow.herokuapp.com/\"\u003e\n\u003cimg src=\"assets/logo.png\" alt=\"Logo\" height=\"100px\"/\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cb\u003e\nQ/A forum for Computer Science \u0026 Engineering students.\n\u003c/b\u003e\n\u003c/p\u003e\n\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://img.shields.io/github/workflow/status/adarshaacharya/CsOverflow/build\" alt=\"github actions\" /\u003e\n\u003ca href=\"https://www.codacy.com/gh/adarshaacharya/CsOverflow/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=adarshaacharya/CsOverflow\u0026amp;utm_campaign=Badge_Grade\"\u003e\n\u003cimg src=\"https://app.codacy.com/project/badge/Grade/0d9e7dd307aa44528e75abc123e01a85\" alt=\"Codacy Badge\" \u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://github.com/adarshaacharya/CsOverflow/blob/master/LICENSE\" target=\"_blank\"\u003e\n\u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/github/license/adarshaacharya/CsOverflow\" /\u003e\n\u003cimg src=\"https://pyheroku-badge.herokuapp.com/?app=csoverflow\" alt=\"Heroku\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://csoverflow.herokuapp.com\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/adarshaacharya/CsOverflow/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/adarshaacharya/CsOverflow/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n  \u003cp align=\"center\"\u003eAsk a question, contribute an answer and upvote your favourite one! CsOverflow gives students correct answer and derivation of all relevant computer science and engineering questions.\u003c/p\u003e\n\n## ⭐ Features\n\n- Token based secured authentication system\n- Feature enriched Quill Text Editor \n- Ask question by categorizing based on tags and perform CRUD optertions\n- Upvote and contribute answer to question\n- Filter question based on tags and search feature\n- Attractive user Dashboard, and many more..\n\n\u003e ⚠️ _Website isn't mobile friendly and for best experience use Google Chrome._\n\n## 💻 Tech Stack\n\n- **Frontend** : Typescript, React.js, Redux\n- **Styling** : Ant Design, Custom Css with BEM naming convention\n- **Backend** : Typescript, Node.js with Express framework\n- **Database** : Sequelize ORM with PostgresSQL database\n- **Deployment** : Server, Client and Database hosted on Heroku\n\n## 📺 Prerequisites\n\nBefore running app locally make sure that you install following things:\n\n- Nodejs with npm or yarn with following version installed :\n  _npm \u003e= 6.14.8 or yarn \u003e= 1.22.4 with node \u003e= 12.19.1_\n- [PostgreSQL \u003e= 13.1](https://www.postgresql.org/) as database.\n- Download \u0026 install [pgadmin](https://www.pgadmin.org/download/) as PostgreSQL client for easier psql database setup.\n\n## 🚀 Local Development\n\n### Step 1: Clone the repo\n\n```bash\n$ https://github.com/adarshaacharya/csoverflow.git\n```\n\n### Step 2: Install dependencies\n\nInstall both client and server dependencies\n\n```bash\n\n# Install dependencies for server\n$ npm install\n\n# Install dependencies for client\n$ npm run client:install\n\n```\n\n### Step 3: Configuration\n\n1. Create `.env` file in project root dir\n\n   ```bash\n   $ touch .env\n   ```\n\n2. Copy everything from `.env.example` as paste it in `.env`\n\n3. Create database named `csoverflow` with `pgadmin` or `postgres cli` from your terminal. _(You don't have to create tables for database)_\n\n4. Replace the fields like`DB_HOST`, `DB_USER`, etc. with your postgres database setup. Place random word as `jsonwebtoken` in `JWT_SECRET`.\n\n5. Checkout my local configuration in `.env.development` file and set your config accordingly.\n\n### Step 4: Usage\n\nNow you can run the application by :\n\n```bash\n\n# Run the client \u0026 server with concurrently (for running full application)\n$ npm run develop\n\n# Run the Express server only\n$ npm run server\n\n# Run the React client only\n$ npm run client\n\n# Server runs on http://localhost:5000 and client on http://localhost:3000\n\n```\n\n## ⛵ Production Deployment\n\nThere is a Heroku post build script so that you do not have to compile your React frontend manually, it is done on the server. Simply push to Heroku and it will build and load the client index.html page\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome. After cloning \u0026 setting up project locally, you can just submit a PR to this repo and it will be deployed once it's accepted.\nRead [CONTRIBUTING.md](https://github.com/adarshaacharya/CsOverflow/blob/master/CONTRIBUTING.md) for complete guide of Contribution\n\n**⚠️ Note - Commit \u0026 PR Title :**\n\nIt’s good to have descriptive commit messages so that other folks can make sense of what your commit is doing.\nThis project uses [Husky](https://github.com/typicode/husky/blob/master/README.md) prevent bad `git commit`, `git push` and more 🐶 \\_woof!\n\nRead [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.3/) before making the commit message.\n\n## 👏🏻 Show your support\n\nGive a ⭐️ if you like the project! :tada:\n\n## 👤 Author\n\n- Website: \u003chttps://adarshaacharya.com.np/\u003e\n- Twitter: [@adarshatweets](https://twitter.com/adarshatweets)\n- Github: [@adarshaacharya](https://github.com/adarshaacharya)\n- LinkedIn: [@adarshaacharya](https://linkedin.com/in/adarshaacharya)\n\n## 📝 License\n\nCopyright © 2020 [Aadarsha Acharya](http://adarshaacharya.com.np/).\u003cbr /\u003e\nThis project is [MIT](https://github.com/adarshaacharya/CsOverflow/blob/master/LICENSE) licensed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadarshaacharya%2Fcsoverflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadarshaacharya%2Fcsoverflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadarshaacharya%2Fcsoverflow/lists"}