BOX UNIVERSE

A Project Fullstack with NodeJS-NestJS-NextJS-MongoDB!

View Demo · Report Bug · Request Feature

Table of Contents

Build
- Client
- Server
About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Contact

Build

Client

Server

About The Project

There are many greate project social media available on Github, however, I didn't find one that really basic, completely and apply many techs common so I created this project. I want to create this project serve my pathway to education and improve my skill developer

Of course, project will not serve all your requirement since your needs may be different. So I'll be adding more feature in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

(back to top)

Built With

This project used techs below. In the future, I may be enhance this project and add some tech to improve or add feature to this project

General

Server-side

Client-side

CI/CD

Hosting

(back to top)

Getting Started

If you want run this project, let following the steps below

I recommend to you run this project with docker but you still can run manual

Before ask to me, please read this carefully and it might helpful

Prerequisites

List software is necessary to run this project

Windows

Using winget

winget install OpenJS.NodeJS

Using scoop

scoop install nodejs

Using chocolatey

cinst nodejs

Linux

curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs

npm install yarn@latest -g

Optional

Windows
- Following this instruction: Install Docker in Windows
Linux
- Following this instruction: Install Docker in Linux

Installation

Clone this repository

git clone https://github.com/kidp2h/box-universe.git

Install dependencies packages
```
cd box-universe
yarn install
```

Enter key each field in .env

 SALT=
 PORT_SERVER=
 PORT_CLIENT=
 PORT_MONGO=
 TIME_EXPIRE_ACCESS_TOKEN=1209600s
 TIME_EXPIRE_REFRESH_TOKEN=7776000s
 SECRET=YOUR-SECRET
 NEXTAUTH_URL=
 BASE_URL_CLIENT=
 BASE_URL_SERVER=

 CONTAINER_SUBNET=
 CONTAINER_CLIENT_IP=
 CONTAINER_SERVER_IP=
 CONTAINER_MONGO_IP=

 CONTAINER_NAME_SERVER=box-universe-server
 CONTAINER_NAME_CLIENT=box-universe-client
 CONTAINER_NAME_MONGO=box-universe-mongo
 MONGO_DATABASE=box-universe
 MONGO_USERNAME=MONGODB-USERNAME
 MONGO_PASSWORD=MONGODB-PASSWORD
 MONGO_URL="mongodb://${MONGO_USERNAME}:${MONGO_PASSWORD}@${CONTAINER_MONGO_IP}:${PORT_MONGO}/${MONGO_DATABASE}?authSource=admin"

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!