Skip to content

Commit

Permalink
Update README.md by adding self hosting instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
nimeshaperi authored Dec 6, 2024
1 parent ae23ee5 commit 2a80f40
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ cd public/markdown
2. **Stage Your Changes**
```bash
# Add your new files
git add .
git add.

# Commit with a clear message
git commit -m "Add documentation for [Crop Name] in [Category]"
Expand Down Expand Up @@ -226,5 +226,32 @@ cd public/markdown
- Be precise in botanical and agricultural descriptions
- Consider multiple climate zones

## Self Hosting
In the case of self-hosting, the source code mentions scripts that can convert all the markdown files into the wiki format and store them as static HTML files. These static HTML files can be hosted in any hosting service, e.g. Github Pages (currently hosted in), Netlify, Google Cloud, etc.

### Running Scripts
If you change anything in the typescript code or tailwind file, run the following script to compile the code down to JavaScript and proper CSS.
```bash
npm run build
```

After running the compiler you run the script by running the following command
```bash
npm run start
```
This will create all the updated static pages that can be seen in the public folder.

### Hosting Locally
To host the website locally to check if the changes are in place first install the npm package serve,
```bash
npm install --global serve
```
Then run the following command,
```bash
npm run serve
```

**Host the website by only uploading the public folder.**

## Contact
For questions or clarifications, please [open an issue](https://github.com/team-watchdog/apoc-gardens-wiki/issues) in the repository.

0 comments on commit 2a80f40

Please sign in to comment.