README.md

LiReddit

Project made to acquire and improve knowledge with GraphQL, NextJS, Chakra UI

🧾 Table of Contents

• Technologies
• Features
• How to Run
• Found a bug? Missing a specific feature?

📷 Web Screenshots

💻 Technologies

This project was made using the follow technologies:

• Typescript
• React
• Express
• URQL
• Apollo
• Node.js
• PostgreSQL
• MikroORM
• TypeORM
• Redis
• Next.js
• TypeGraphQL
• Chakra

🚀 Features

• Web system that works like reddit, you can create a post, updoot or downdoot on some post.

👷 How to run

ℹ️ If you want (and have docker configured in your computer), you can download the docker container with all pre-configured environment.

# Download container
$ docker pull adsonatural/lireddit:1.2

or clone the repository

# Clone Repository
$ git clone https://github.com/AdSoNaTuRaL/lireddit.git

📦 Run API

ℹ️ Before you run the api, make sure you have redis installed and running and a postgresql database installed and running (you must create a database). After that create an .env file and fill it, with the example information from the .env.example file

# Go to server folder
$ cd lireddit/server

# Install Dependencies
$ yarn

# Run Aplication (watch)
$ yarn watch

# Run Aplication
$ yarn dev

💻 Run Web Project

# Go to web folder
$ cd lireddit/web

# Install Dependencies
$ yarn

# Run Aplication
$ yarn dev

Go to http://localhost:3000/ to see the result.

🐛 Issues

Feel free to create a new issue with a respective title and description on the LiReddit repository. If you already found a solution to any problem, I would love to review your pull request!