Giter VIP home page Giter VIP logo

gdsc-space's Introduction

GDSC CAU Space ๐Ÿก

Rules ๐Ÿค

All Rules are here. Check it out carefully :)

Setup โš™๏ธ

  1. Install IDE

    • vscode
    • web storm
    • ...
  2. Install Plugin at your IDE

  3. Install Node.js

    Install Node.js, recommended after v18.x.x

  4. Install pnpm, package manager

    pnpm setup documentation is here!

    Simply, run this command in your terminal.

    npm install -g pnpm
    • npm: installed, when Node.js is installed.
    • pnpm: faster version of npm which is package manager.
  5. Install project dependencies

    Run this command at your terminal

    pnpm i

    After installation, node_modules folder will be generated.

  6. Run development server

    pnpm dev

    After running this command, you can see the website at localhost:3000. Develope your project with this server.

    dev guide

  7. Build project

    Run below command at your terminal

    pnpm build

    After building process, you can see the website at localhost:3000 in production mode which is optimized for performance(=lightweight version of project).

    Log message should be look like this.

    Route (app)                                 Size     First Load JS
    โ”€ โ—‹ /                                      137 B          77.6 kB
    + First Load JS shared by all               77.5 kB
    โ”œ chunks/14478101-08a82aad1ad550e2.js       50.5 kB
    โ”œ chunks/215-693f32f7887d2092.js            25.1 kB
    โ”œ chunks/main-app-5d9d2d6e73ea2558.js       216 B
    โ”” chunks/webpack-56d4ed22b847b2bf.js        1.64 kB
    
    Route (pages)                               Size     First Load JS
    โ”€ โ—‹ /404                                   182 B          75.4 kB
    + First Load JS shared by all               75.2 kB
    โ”œ chunks/framework-510ec8ffd65e1d01.js      45 kB
    โ”œ chunks/main-d211b781428a7a0f.js           28.3 kB
    โ”œ chunks/pages/_app-3e277c1f911fda65.js     195 B
    โ”” chunks/webpack-56d4ed22b847b2bf.js        1.64 kB
    
    โ—‹  (Static)  automatically rendered as static HTML (uses no initial props)

Core Stacks ๐Ÿ› ๏ธ


Run Tests ๐Ÿ›ก๏ธ

  1. Unit test: Jest + React testing library
  2. e2e test: Playwright

Test categories

  1. unit test ๐Ÿ”ฉ

Write test code using watch mode.

pnpm test

Run CI tests

pnpm test:ci
  1. e2e test โ›ฐ๏ธ

First, setup Playwright with this command.

npx playwright install

And then run e2e test.

pnpm e2e:ci

If you want inspect full ci test process, run this command.

pnpm e2e:inspect

Project Structure Overview ๐Ÿ“–


[src] - project root
 โ”ƒ
 โ”ฃ <app> - Next.js app
 โ”ƒ
 โ”ฃ <components> - Shared components
 โ”ƒ
 โ”ฃ <styles> - Style sources
 โ”ƒ
 โ”ฃ <utils> - Utility helpers
 โ”ƒ
...

gdsc-space's People

Contributors

danpacho avatar yymin1022 avatar pjw-redt avatar lucete012 avatar causyj 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.