🌎NanoScientific 2022🌎

Explore Site Right Now ❗️ ❕

for global nanoscientific website
Explore the Organization

Report Bug · Request Feature

Table of Contents

1. • Built With
2. Getting Started
   • Convention
   • Commit Convention
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

Built With

Frontend

Backend

etc

(back to top)

Getting Started

convention

• Coding Convention

1. React folder Structure

   /SomeComponent or page folder
   ├── SomeComponent.tsx
   └── SomeComponentStyles.tsx
   /SomeComponent2 or page folder
   ├── SomeComponent2.tsx
   └── SomeComponen2tStyles.tsx

2. prettier

   {
     "singleQuote": false,
     "semi": true,
     "useTabs": false,
     "tabWidth": 2,
     "trailingComma": "all",
     "printWidth": 80,
     "arrowParens": "always"
   }    

3. Camel Case

   lectureHall
   lastName

4. styled-components 구조: 최상위 태그에만 한 번

   const StyledTag = styled.div``;
   
   return (
       <StyledTag>
           <div>Not</div>
           <div>There</div>
       </StyledTag>
   );

5. 타입 관리

• 전역적으로 재사용될 타입: src/@types/index.d.ts에서 declare하여 정리(import, export 필요 없음)
• 단 하나의 컴포넌트에만 쓰이는 타입은 해당 파일 내부에 선언해도 무관
• 타입 선언 방식: interface(대부분의 타입) + type alias(원시 타입)

Commit Convention

feat: 새로운 기능에 대한 커밋
content: 내용 design: UI 수정 및 구현에 대한 커밋 fix: 버그 수정에 대한 커밋
build: 빌드 관련 파일 수정에 대한 커밋
etc: 그 외 자잘한 수정에 대한 커밋
docs: README.md 수정에 대한 커밋
style: 코드 스타일 혹은 포맷 등에 관한 커밋(prettier 등)
refactor: 코드 리팩토링에 대한 커밋

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a free API Key at https://example.com

2. Clone the repo

   git clone https://github.com/Park-Systems-web/Nanoscientific-Symposium.git

3. Install NPM packages both client and server

   npm install

4. Enter your API in .env sholud be included both client and server folder

     client/.env
     
     API_KEY is secret

     server/.env
     
     API_KEY is secret

(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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Eric Kim - GitHub - eric.kim@parksystems.com

Chanhyuk Park - GitHub - chanhyuk-tech@kakao.com

Project Link: NanoScientific Symposium !!!

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)

Command

Nginx restart

sudo service nginx restart

Server restart should be inside in server folder

sudo forever restart index.js