close
The Wayback Machine - https://web.archive.org/web/20221031073317/https://github.com/henrispkl/MernBB
Skip to content

henrispkl/MernBB

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

MernBB

A forum board built with React, Ant Design, Express, Node and MongoDB

alt text

πŸ“ Description

DocumentaΓ§Γ£o em PT-BR

Using the MERN stack, this is a bulletin board where users can authenticate and post topics and reply to them in different categories divided by subcategories. The user can authenticate with JWT to start consuming an API with CRUDs and other operations for categories, subcategories, users, user groups, topics and posts.

Live example

πŸ“Œ Technologies used

  • React with hooks
  • React Router
  • Ant Design
  • JWT authentication via Passport.js
  • Node
  • MongoDB

πŸš€ Roadmap

  • Make everything responsive
  • Edit user profile
  • View user profile
  • Dashboard for administrators
  • Manage user groups, categories and subcategories in the dashboard
  • WYSIWYG text editor
  • Delete and topics and posts
  • Add proper testing files and prop-types
  • ... a lot of other things!

⚑ Getting Started

πŸ“¦ Installing

  • Clone this repo

    git clone https://github.com/henrispkl/MernBB.git
    
  • Go to the folder and install all dependencies

    cd MernBB/
    npm install
    
  • Rename the .env.example file to .env, add a MongoDB connection string and change the JWT secret.

    mv .env.example .env
    
  • Build the project

    npm run build
    

πŸ”₯ Executing

  • Running in development mode

    npm run dev
    
  • Executing in production

    npm start
    

πŸ‘ How to contribute

To contribute to this project, feel free to create pull requests and issues and I'll gladly take a look at them. :)

πŸ“„ License

This project is licensed under the MIT License. I ❀️ open source stuff!