https://github.com/dr5hn/csc-website
Country State City API - Official Website - Built with Docusaurus
https://github.com/dr5hn/csc-website
api-documentation api-documentation-website documentation docusaurus docusaurus2
Last synced: 2 months ago
JSON representation
Country State City API - Official Website - Built with Docusaurus
- Host: GitHub
- URL: https://github.com/dr5hn/csc-website
- Owner: dr5hn
- License: mit
- Created: 2020-10-07T12:37:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T10:46:32.000Z (7 months ago)
- Last Synced: 2025-03-29T19:01:53.812Z (3 months ago)
- Topics: api-documentation, api-documentation-website, documentation, docusaurus, docusaurus2
- Language: JavaScript
- Homepage: http://countrystatecity.in/
- Size: 2.67 MB
- Stars: 16
- Watchers: 3
- Forks: 106
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Country State City API Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
## Installation
```console
yarn install
```
## Local Development
```console
yarn start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
## Build
```console
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
```console
GIT_USER= USE_SSH=true yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.