Code Monkey home page Code Monkey logo

soclone's Introduction

StackOverflow Clone

Description

The objective of this project is to create a light version of the popular website stackoverflow

Table of Content

Documentation

The API documentation is available here.

System Requirements

Your system will need to have the following software installed. For mongoDB, a connection string from mongoDB atlas should do:

Technologies

  • nodeJS/express
  • JWT(authentication)
  • mongoDB
  • pusher(notifications)
  • redis
  • mocha and chai

Installation

Step 1: Clone the repository

git clone https://github.com/danoseun/SOClone
cd SOClone

Step 2: Setup database

Add the connection string gotten from mongoDB atlas to the .env file in your project.

Step 3: Setup environment variables

Include necessary variables as found in .env.sample into .env

Step 4: Install NPM packages

npm i

Step 5: Start in development mode

npm run start:dev

Testing

npm test(All tests are passing).

ThoughtProcess

  • For registration/signup, users have to provide their firstname,lastname,email,username and password.

  • Login(username and password) returns only the token.

  • Currently, you have to upvote a question before downvoting.

  • You can also search for questions by title and users by username.

  • All search requests are case insensitive and like searches which means it returns results similar to what you entered in the query string irrespective of the case orientation.

  • Only the GET /questions route is unprotected, all other routes are private.

soclone's People

Contributors

danoseun avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.