Giter Club home page Giter Club logo

ideahub-jbnu's Introduction

cmanager

cmanager is competition management service, made with React, Koa.js and MongoDB.

used...

nodejs v12.13.0
npm 6.12.0
yarn 1.19.1

on progressπŸ˜”

get started!

you should run backend and frontend server respectively.

  1. make .env file containing DB informations in backend directory.
//YOURDIRECTORY\cmanager\backend\.env

PORT=YOUR_PORT
MONGO_URI=YOUR_DB_URL
JWT_SECRET=YOUR_SECRET_KEY
  1. move into frontend directory then run the following code.
cd YOURDIRECTORY\cmanager\frontend
yarn start
or
npm install
npm start
  1. move into backend directory then run the following code.
cd YOURDIRECTORY\cmanager\backend
yarn start:dev

example website will be presented on browser. or visit localhost:3000

  1. trouble shotting

    react-scrpts: Permission denied

    ENOENT ERROR

🎨Style

this project uses styled-components.

if you want change style or theme, check out styled-components in each file in

YOUR_DIRECTORY\cmanager\frontend\src\components

βš™Structure - frontend

src
β”œβ”€β”€ components // each components styled with 'styled-components'
β”‚   β”œβ”€β”€ auth //components used when authorization happened
β”‚   β”œβ”€β”€ base
β”‚   └── common // components used globally
β”œβ”€β”€ containers // manages redux-linked components.
β”‚   β”œβ”€β”€ auth
β”‚   └── common
β”œβ”€β”€ lib
β”‚   β”œβ”€β”€ api // connects frontend and backend.
β”‚   └── styles // to use basic colors easily, defined color codes as object.
β”œβ”€β”€ pages // page components
└── modules // manages reducers.

βš™Structure - backend

backend
β”‚
src
β”œβ”€β”€ api // Schema verifications and http methods.
β”‚   β”œβ”€β”€ auth
β”‚   └── posts
β”œβ”€β”€ lib // middlewares that verificate tokens.
└── models // Schema, methods...

contributing

WE NEED YOUR HELP! wanna contribute on this project? check out contributing guidline.

ideahub-jbnu's People

Contributors

repusjh avatar dangsal avatar hyunchan-park avatar khoon-git 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.