Code Monkey home page Code Monkey logo

awards-app's Introduction

Awards App

Requirements

Setup

[Step 1] Database Preparation

  1. Create a database in Postgres SQL

[Step 2] Server Preparation

  1. Go to server directory. cd server

  2. Create .env file using this command cp .env.example .env

  3. Complete the values of .env file with your setup

    Notes: For AWARDS_DB_NAME in .env file, fill it with your database name in Step 1

     # Database Credentials
     AWARDS_DB_HOST={your_database_host}
     AWARDS_DB_NAME={your_database_name}
     AWARDS_DB_USERNAME={your_database_username}
     AWARDS_DB_PASSWORD={your_database_password}
     AWARDS_DB_PORT={your_database_port}
    
     # JWT Secret
     AWARDS_JWT_SECRET_KEY={jwt_secret}
  4. Install dependencies. npm install or yarn

  5. Migrate the database. npm run typeorm:run-migrations or yarn typeorm:run-migrations

  6. Start server. npm run start:dev or yarn start:dev

    Notes: Server is running on PORT 5000, make sure there is no running application or service on PORT 5000

[Step 3] Client Preparation

  1. Go to client directory. cd client

  2. Install dependencies. npm install or yarn

  3. Start client. npm run dev or yarn dev

Usage

  1. Go to the url http://localhost:5173/ in your browser

    Notes: By default, the url is http://localhost:5173/ or you can copy the url on the terminal after you start the client

  2. Login with email [email protected]

awards-app's People

Contributors

hakimscode avatar

Watchers

 avatar  avatar

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.