Skip to content

Kurakoo is an online community of people providing answers to questions just like Quora site. Kurakoo is especially for school-college students, people from around the different colleges visit Kurakoo to ask questions from a community of people who answer them.

License

Notifications You must be signed in to change notification settings

purnima143/Kurakoo

Repository files navigation

kurakoo-logo

forthebadge forthebadge forthebadge forthebadge

Kurakoo is a website where you can make friends (safely) and learn more from people you trust. It is an online community of people providing answers to questions, just like 'Quora'. Kurakoo is specially catered to meet the needs of school/college students. Students from different colleges/universities around the world visit Kurakoo to ask questions to a community of people who are always ready to answer them.

Project BackgroundπŸ’‘

In the majority of the colleges and universities across India, thousands of students have many doubts and queries from "Which branch to choose?" to "How to crack interviews?". Kurakoo is a one-stop solution for all these problems. It serves as a platform where students can drop in their questions for public view and any person from this vibrant community can help by providing answers to these questions.

Issues Pull Requests Forks Stars License Β 

Areas of Collaboration πŸ‘¨β€πŸ­

Project Managers, Developers, and Designers would be collaborating on various domains like:

  • UI Prototyping with figma tool figma design.

  • Front-End Development with ReactJS

  • Developing Backend APIs with NodeJS and MongoDB

  • Working on a NoSQL Database Management System

  • Working on a User-Experience rich platform for a Social Cause

This would be an enriching experience for all Student Developers, Project Managers, and Designers.

Technology Stack πŸ› οΈ

  • Coding Languages: JavaScript

  • Tools & Technologies: React MongoDB Express.js NodeJS Mocha Chai

  • Project Management Tools: Trello GitHub Git Markdown

Flow of the site πŸ’»

Below is a basic idea as to how the website works. We will also be working on adding more features to this project, like sharing of questions, an option to follow people, a feature that allows users to filter and view specific content, etc.

Kurakoo Website

General Guidelines 🎯

  • Before working on any issue, kindly go through the instructions given in the contributing and readme the file carefully.

  • For each issue, a detailed explanation is mentioned in the issue ticket itself, for more details refer to figma design.

  • While making any component, make sure that the code for the all generalised/common components is kept in src->components->common folder.

  • Kindly keep the source code in the src->components folder while making specific components.

  • Please make sure to adhere to the folder structure of the project.

We will also be working on adding more features to this project.

Setup Guidelines

Clone the repository -

git clone https://github.com/purnima143/Kurakoo.git

Backend

  1. Run cd server on your CLI.

  2. Create a .env file and paste the MONGO_URL, node environment and email for nodemailer in the given format

    MONGO_URL = <your_url>
    NODE_ENV = development
    USER_MAIL=<Enter your mail-id from where you want to send the mails>
    MAIL_PASSWORD=<password of the entered mail-id for the authentication>
    

    or

For the MONGO_URL, We have added a string for the local mongoDB connection inside index.js mongodb://localhost:27017/kurakooDB

Note: See the .env.example file for further clarity

_NOTE: To get the MONGO_URL, take a look at this article for reference [Connection String URI Format](https://docs.mongodb.com/manual/reference/connection-string/)_
  1. Install the dependencies by running

    npm install
    
  2. Run the server

    npm run server
    

    Link for the screenshots, how to setup backend locally are kept in assets->backend folder.

Frontend

  1. Run cd client on your CLI.

  2. Install the dependencies by running

    npm install
    
  3. Run the server

    npm start
    

NOTE: To run the Frontend side of the application is recommended to run the backend server too.

Start Frontend & Backend simultaneously

  1. Navigate to the root folder i.e. Kurakoo.git

  2. Install the dependencies by running

    npm install
    
  3. Start Frontend & Backend simultaneously

    npm run dev
    

Unit Testing

  1. Currently we are working on the implementation of unit-tests.

  2. This will improve the our codebase & help to manage all the wierd cases.

  3. We are using Mocha & Chai for the unit-testing. We welcome you, for helping us to improve test casing.

Open source contest

Girlscript Summer of Code 2021: The GirlScript Summer of Code is a 3 month long Open Source program conducted every summer by the GirlScript Foundation. It was started in 2018 to help beginners to get started with Open Source Development while encouraging diversity.

0_hvZkvLGPR4t6TFhS

Learning Resources 🧰

LicenseπŸ“œ

MIT License

All Contributors

Project Admin πŸ“†

Purnima Sharma

Project Mentors πŸ‘¨β€πŸ’»


Ahmed Mawia


Ishu Raj


Vivekkumar Javiya

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Kurakoo is an online community of people providing answers to questions just like Quora site. Kurakoo is especially for school-college students, people from around the different colleges visit Kurakoo to ask questions from a community of people who answer them.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages