franzinBr / Plan-in

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Plan-in

video app run

https://youtu.be/p1HcFKKivbY

Video DEMO

Demo

https://plan-in.herokuapp.com/

πŸ’» technology used

πŸ–§ Back-end:

πŸ–‹ Front-end:

βš™ Installation

πŸ“¦ Yarn

If you don't have the yarn package manager, consider installing it with the following command:

npm install --global yarn

πŸ–₯ Server

yarn install

πŸ–₯ Client

cd client
yarn install

🎲 Database

This application uses mongoDB, if you don't know how to create a database in mongo, here is a tutorial.

I recommend using the mongo db cloud service: MongoDB Atlas.

πŸ”§ Configuration

  • Rename the env.sample file to .env
  • Open the .env file and fill it in with the required information
    • MONGO_URI
    • AUTH_TOKEN_SECRET
    • AUTH_TOKEN_EXPIRE
    • REFRESH_TOKEN_SECRET
    • REFRESH_TOKEN_EXPIRE

🟒 Running

Start the server:

yarn start

Note: to start the server using nodemon use the following command:

yarn dev

by default the server will start on port 3080, therefore the server will be at http://localhost:3080

if the port is changed, open the client\src\services file and modify the baseURL attribute, informing the new port

Start the client:

cd client
yarn start

by default the server will start on port 3000, therefore the client will be at http://localhost:3000

Dashboard

only users with admin privileges can access the panel, by default when they start the application the admin user will be:

Username: admin
Password: admin

but if you want you can change this user in src\configs\adminUser.json

{
    "defaultAdminName": "admin",
    "defaultAdminUsername": "admin",
    "defaultAdminEmail": "admin@admin.com",
    "password": "admin"
}

Documentation

if you want to see more details on how the API works, just access the documentation at: http://localhost:3080/api-docs

About


Languages

Language:JavaScript 97.9%Language:HTML 2.1%