A MERN Stack Social Media App for Developer Community
Explore the docs ยป
Table of Contents
-
About The Project
- Built With
-
Getting Started
- Prerequisites
- Installation
- Contributing
- License
- Contact
- Acknowledgements
About The Project
As a developer networking is matter. Why it's matter ?
- We work in teams
- We share our work
- We share our exprerience
and we do many things where networking is important and Outreach is providing platform for meeting new people around the world
The main aim for building this app was to learn MERN stack
Built With
This project use morden techonology for web development.
Getting Started
Prerequisites
This app is using MERN Stack so for getting started with this code you need some basic knowledge
- ES 6 Concept
- React Components
- React Hooks
- Node JS
- Express JS
- MongoDB
Installation
Add a default.json file in config folder with the following
{
"mongoURI": "<your_mongoDB_Atlas_uri_with_credentials>",
"jwtSecret": "secret",
"githubToken": "<yoursecrectaccesstoken>"
}
Install server dependencies
npm install
Install client dependencies
cd client
npm install
Run both Express & React from root
npm run dev
Build for production
cd client
npm run build
Test production before deploy
After running a build in the client
And run...
Linux/Unix
NODE_ENV=production node server.js
Windows Cmd Prompt or Powershell
$env:NODE_ENV="production"
node server.js
Check in browser on http://localhost:5000/
Contributing
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Ashish Patel - @ashishxcode - ashishxcode@gmail.com
Project Link: https://github.com/ashishxcode/Outreach