Skip to content

Commit c9cc630

Browse files
committed
update docs
1 parent 366c610 commit c9cc630

File tree

3 files changed

+65
-32
lines changed

3 files changed

+65
-32
lines changed

apps/nextjs-pages/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Next.js Pages Application
2+
3+
## Get Started
4+
5+
Prerequisites:
6+
7+
- Node 20+
8+
- Yarn 1.22+
9+
10+
To set up the app execute the following commands.
11+
12+
```bash
13+
git clone https://github.com/alan2207/bulletproof-react.git
14+
cd bulletproof-react
15+
cd apps/nextjs-pages
16+
cp .env.example .env
17+
yarn install
18+
```
19+
20+
#### `yarn run-mock-server`
21+
22+
Make sure to start the mock server before running the app.
23+
The mock server runs on [http://localhost:8080/api](http://localhost:8080/api).
24+
25+
##### `yarn dev`
26+
27+
Runs the app in the development mode.\
28+
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
29+
30+
## Project Structure
31+
32+
Since the `pages` folder isn't very flexible and doesn't allow file collocation, we are keeping the `app` folder which is our application layer where we compose all the features, and then we just re-export Next.js page specific files (the pages and `getServerSideProps`) from the `pages` folder so Next.js can pick them up and serve as pages.

apps/react-vite/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# React Vite Application
2+
3+
## Get Started
4+
5+
Prerequisites:
6+
7+
- Node 20+
8+
- Yarn 1.22+
9+
10+
To set up the app execute the following commands.
11+
12+
```bash
13+
git clone https://github.com/alan2207/bulletproof-react.git
14+
cd bulletproof-react
15+
cd apps/react-vite
16+
cp .env.example .env
17+
yarn install
18+
```
19+
20+
##### `yarn dev`
21+
22+
Runs the app in the development mode.\
23+
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
24+
25+
##### `yarn build`
26+
27+
Builds the app for production to the `dist` folder.\
28+
It correctly bundles React in production mode and optimizes the build for the best performance.
29+
30+
See the section about [deployment](https://vitejs.dev/guide/static-deploy) for more information.

docs/application-overview.md

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
# 💻 Application Overview
22

3-
The sample application has been bootstrapped using `Vite` and its `react-ts` template. It allows us to create applications quickly without dealing with a complex tooling setup such as bundling, transpiling etc. Another reason for using Vite is simplicity, as it doesn't force us to use the meta-framework specific things, and allows us to focus on React.
4-
5-
Other popular ways you can bootstrap the application are:
6-
7-
- [Next.js](https://nextjs.org/)
8-
- [Remix](https://remix.run/)
9-
103
The application is relatively simple. Users can create teams where other users can join, and they start discussions on different topics between each other.
114

125
A team is created during the registration if the user didn't choose to join an existing team and the user becomes the admin of it.
@@ -36,29 +29,7 @@ The application contains the following models:
3629

3730
## Get Started
3831

39-
Prerequisites:
40-
41-
- Node 20+
42-
- Yarn 1.22+
43-
44-
To set up the app execute the following commands.
45-
46-
```bash
47-
git clone https://github.com/alan2207/bulletproof-react.git
48-
cd bulletproof-react
49-
cd apps/react-vite
50-
cp .env.example .env
51-
yarn install
52-
```
53-
54-
##### `yarn dev`
55-
56-
Runs the app in the development mode.\
57-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
58-
59-
##### `yarn build`
60-
61-
Builds the app for production to the `dist` folder.\
62-
It correctly bundles React in production mode and optimizes the build for the best performance.
32+
To get started, check the README.md file in the application you want to run.
6333

64-
See the section about [deployment](https://vitejs.dev/guide/static-deploy) for more information.
34+
- [React Vite](../apps/react-vite/README.md)
35+
- [Next.js Pages](../apps/nextjs-pages/README.md)

0 commit comments

Comments
 (0)