Skip to content

Commit

Permalink
chore: readme 업데이트
Browse files Browse the repository at this point in the history
  • Loading branch information
Bhanjo authored Oct 19, 2023
1 parent d3ed09f commit 921a7a4
Showing 1 changed file with 58 additions and 7 deletions.
65 changes: 58 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,62 @@
# Interstellar
# Getting Started with Create React App

(코드명) 크리스토퍼 백엔드
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Starting server locally
## Available Scripts

```bash
# (future) set .env file
yarn install
yarn start:dev
In the project directory, you can run:

### `yarn start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `yarn test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `yarn build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `yarn eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

## HTTPS 설정

서버 통신을 위해 https 설정이 필요합니다.
macOS의 경우 homeBrew, Windows의 경우 choco가 필요합니다
HTTPS 설정을 원할 경우 문의 바랍니다.

```shell
# package.json의 "start:https"를 아래와 같이 설정합니다.

# macOS
"HTTPS=true SSL_CRT_FILE=cert/cert.pem SSL_KEY_FILE=cert/cert-key.pem craco start",

# window
"set HTTPS=true&&set SSL_CRT_FILE=cert/cert.pem SSL_KEY_FILE=cert/cert-key.pem&&craco start",
```

0 comments on commit 921a7a4

Please sign in to comment.