aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 70ebe6f4d0e7b280dc16aec2e865df42b48a182d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Python Discord Forms Frontend
The frontend component of the [Python Discord Forms](https://github.com/python-discord/forms-backend/) project.
Backend available at: [python-discord/forms-backend](https://github.com/python-discord/forms-backend/).

Our frontend is written in React.js and TypeScript.
It's a fairly simple application to get your head around,
with the whole thing broken down into smallish TypeScript components.

## Setup & Troubleshooting
The project uses [yarn](https://yarnpkg.com/) for dependency and script management,
and [webpack](https://webpack.js.org/) for building and development.

A full setup guide is available on [Notion](https://pythondiscord.notion.site/Get-Started-30458bfb32ce4a0e9c489ea66daf0323),
along with a troubleshooting guide.<br/>

## React & Dependency Info
### Project Info
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

### Available Scripts
In the project directory, you can run:

`yarn start`

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

The page will reload if you make edits.<br/>
You will also see any lint errors in the console.

`yarn test`

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

`yarn lint`

Runs eslint on the src directory of the project.<br/>
Code style can be found under [.eslintrc.json](.eslintrc.json).

`yarn build`

Builds the app for production to the `build` folder.<br/>
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.<br/>
Your app is ready to be deployed!

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

### 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/).