Giter VIP home page Giter VIP logo

golb's Introduction

GOLB Community

screenshot

Note: This project is for demo purpose, which means it's not yet ready for production.

Pretty SSR blogging website using Next.js and Express.js.

Features

  • Guest users can read all the posts but cannot comment until they login.

  • Authenticated users can create/update/delete their own posts, as well as comment on all other posts using their credentials.

  • Everyone can login using his/her GitHub or Twitter (coming soon) account.

  • Everyone can search/filter posts using keywords that match the post title and body.

  • Post list can be paginated.

Demo

See the public demo of the GOLB community!

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes

Prerequisites

  • Node.js 12.0+

  • MongoDB 4.2.7+

  • GitHub OAuth app. Create here.

Installing

Clone the repository:

git clone https://github.com/duongdev/golb.git

Enter the project directory:

cd golb

Install NPM dependencies:

yarn

Add .env files:

# packages/server/.env
GH_CLIENT_ID=     # GitHub app client ID
GH_CLIENT_SECRET= # GitHub app client secret
JWT_SECRET=       # JsonWebToken secret key
MONGO_URI=        # MongoDB server URI
# packages/web/.env
NEXT_PUBLIC_GH_CLIENT_ID= # GitHub app client ID
NEXT_PUBLIC_SERVER_URI=   # Address of the server

Development

Run the development servers:

# Web
yarn workspace web dev
# Server
yarn workspace server watch:dev

Go to http://localhost:3000 to access the website and http://localhost:4000 to access express server.

Production

Build the web and server:

# Web
yarn workspace web build
# Server
yarn workspace server build

Start the production servers:

# Web
yarn workspace web start
# Server
yarn workspace server start

golb's People

Contributors

duongdev avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

anhbaysgalan1

golb's Issues

Product Testing

Hi Dương,

I'm Thi, Product Owner from Bizzi. I will run UAT for the testing project.
I'm going to log all bugs I detected.

Thanks,

v1.0 Road map

Core features

  • Guests can read all the posts.
  • Authenticate with email/password or social account.
  • Authenticated users can create new posts and update/remove their own posts.
  • Authenticated users can comment on any post.
  • Posts can be searched/filtered.
  • Deploy to Vercel and Heroku.

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.