MUMBLE
An Open Source Social Media Platform and Public Forum for Questions and Discussions, built for Developers.
Download & Setup Instructions :
Before downloading the project, check to make sure you meet the project's requirements.
Clone the project. This will download the GitHub respository files onto your local machine.
git clone https://github.com/divanov11/mumble
Frontend Instructions (Create React App) :
---> Navigate to the frontend/
directory
cd Mumble && cd frontend
---> Install the project dependencies
npm install
---> Start the development server on localhost:3000
npm run start
---> Open your browser and navigate to either http://localhost:3000 or http://127.0.0.1:3000
Want to Contribute?
Check out the contributing guide. Also if you are looking for a complete style guides, please refer to Mumble Style Guide. We highly recommend to go through the guideline before start contributing.
_β Those who wants to contribute on the repo, from now, before pushing/committing your changes, please make sure you run command
npm run format
oryarn format
or use Prettier plugin to automatically format your code. We want to maintain consistency that's why we want to enforce the formatting. It's required! _
Reviewers :
After submitting your PR, please tag reviewer(s) in your PR message. You can tag anyone below for the following.
-
Markdown, Documentation changes :
Request @Mehdi - MidouWebDev's review !
-
Frontend, Design :
--> Choose two reviewers :
πΈ Screenshots :
User Feed :
Β
Light Mode |
Dark Mode |
User Profile Page :
Β
Light Mode |
Discussion/Question Page :
Β
Light Mode |
Login Page :
Β
Light Mode |
Dark Mode |