Skip to content

Latest commit

 

History

History
160 lines (117 loc) · 5.32 KB

README.md

File metadata and controls

160 lines (117 loc) · 5.32 KB
Raw

DevConnector

Login Details for Testing

email: [email protected]
password: test1234

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

  • It's a mini Social Network for Developers, where they can post about different technologies and have disscusion on it. One can get information about what and where developers work and what they are currently doing.

Built With ~~

This is project is built with the latest MERN stack technology, React for frontend, React-Redux for state managment, Express/Node for API, server and MongoDB for database, including json-webtoken for authorization and Bycrypt for encryption and decryption

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

The only thing required to download other dependencies is npm.

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo 
    git clone https://github.com/lavlife06/DevConnector.git
  2. Install NPM packages 
    npm install
    in client folder - npm install
  • These will download every dependencies for frontend and backend
  1. Set up MongoDB database
  • Make a project in MongoDB
  • You will get your cluster's mongoURI to use database of your project
  • Enter your mongoURI in config.js
const mongoURI = 'ENTER YOUR MongoDB URI here';
  1. Run
  npm run dev

Contributing

I believe Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact

Name - Lav Senghani - [email protected]