Skip to content

Commit 11ab878

Browse files
committed
Update README.md to include project structure and getting started instructions #5
1 parent 68d471e commit 11ab878

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
11
# website
22
Official website, documentation, blog, and community hub for Synentra.
3+
4+
## Project Structure
5+
6+
- **`.docusaurus/`**: Contains Docusaurus configuration files and plugins.
7+
- **`blog/`**: Blog posts for the website.
8+
- **`docs/`**: Documentation files for Synentra.
9+
- **`src/`**: Source code for the website.
10+
- **`static/`**: Static assets like images and files.
11+
- **`build/`**: Generated build files for deployment.
12+
- **`package.json`**: Project dependencies and scripts.
13+
- **`README.md`**: Project overview and instructions.
14+
15+
## Getting Started
16+
17+
1. **Install dependencies**:
18+
```sh
19+
npm install
20+
```
21+
22+
2. **Start the development server**:
23+
```sh
24+
npm start
25+
```
26+
27+
3. **Build the project**:
28+
```sh
29+
npm run build
30+
```
31+
32+
4. **Serve the build locally**:
33+
```sh
34+
npm run serve
35+
```
36+
37+
## License
38+
This project is licensed under the terms of the LICENSE file.

0 commit comments

Comments
 (0)