Code Monkey home page Code Monkey logo

codev-hh2's Introduction

CoDev

Collaborate with some of the best developers around the world


๐Ÿค” What is CoDev?

CoDev is a social media platform wherein the users can register themselves with their email ids and provide us their github id. We will seamlessly fetch all of his github achievements to showcase it on our profile page. We can view the profiles of other amazing developers and Collaborate with them to initiate a chat and discuss any thing related to tech or otherwise๐Ÿ˜‰. Tired of seeing the same user again and again? The users can even Pass the user and we do make sure to never show his/her profile again unless you change your mind.

๐Ÿ’กInspiration

Me and my team member Puja Saraf have always been a hackathon enthusiast. One problem we always ran into was finding the perfect team members for our hacks. We do have some amazing ideas to implement but the required tech stacks sometimes goes out of our bounds. Registering for a hackathon and then forming a team then and there isn't something for us. We'd prefer planning our projects beforehand and get to know our team mates better. That's when we came up with CoDev.

โ“ About CoDev

This website was built with React, Express and Node. It also has text chat functionality to communicate with fellow developers!

Codev is now a Progressive Web App (PWA), you can add it to your homescreen and it behaves like a mobile app.

๐Ÿง How to Use?

  1. Once you're on the homepage you can either login with an existing one or signup with a new email id
  2. You will now be redirected to a create profile page where in you can fill the required details to get started.
  3. Once done with this you will see a list of developers and you can Collaborate or Pass any user.
  4. You can initiate a chat with the users you chose to collaborate with

๐ŸŽฎ Screenshots

Screenshot 1

Screenshot 2

Screenshot 3

Screenshot 4

Screenshot 5

๐Ÿ Getting Started (to run locally)

Follow the steps below, after cloning the repository:

๐Ÿ– Requirements

For Installing:

  • Node

For Running:

  • Create a .env file inside the backend folder and then delcare the following two variables inside it
    • PASSWORD="Your atlas password"
    • USER="your atlas username"
  • Go to frontend/package.json and add the following line:- "proxy":"http://localhost:8000",
  • Go to frontend/src/api/index.js and change the base url from https://codevv.herokuapp.com to http://localhost:8000 (at line no. 2)

โณ Installation

  • At the root of the project directory, use npm to install the server-side dependencies
npm install

This command installs all the server-side dependencies needed for the game to run locally.

  • Use npm to run server
npm start

This command gets the server running on localhost port 8000.

  • In a separate terminal, navigate into the frontend folder and use npm to install the client-side dependencies
cd frontend
npm install

This command installs all the client-side dependencies needed for the website to run locally.

  • Finally, use npm to run frontend
npm start

This command gets the client running on localhost port 3000.

Head over to http://localhost:3000/ and enjoy! ๐ŸŽ‰

๐Ÿ‘ป Testing

The project includes unit tests for testing all the routes and controllers, written using jest and supertest.

Run all tests

npm run test

๐Ÿ‘จโ€๐Ÿ’ป๐Ÿ‘ฉโ€๐Ÿ’ป Contributors


(Since Codev is currently in Beta we request to always provide a valid github id while creating a profile)

codev-hh2's People

Contributors

jalanprakhar avatar puja-saraf 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.