https://github.com/bottenderjs/bottenderjs.github.io
The Bottender website
https://github.com/bottenderjs/bottenderjs.github.io
bottender
Last synced: 12 months ago
JSON representation
The Bottender website
- Host: GitHub
- URL: https://github.com/bottenderjs/bottenderjs.github.io
- Owner: bottenderjs
- Created: 2017-10-31T09:44:21.000Z (over 8 years ago)
- Default Branch: source
- Last Pushed: 2023-01-11T20:07:57.000Z (over 3 years ago)
- Last Synced: 2025-04-13T00:54:18.161Z (about 1 year ago)
- Topics: bottender
- Language: JavaScript
- Homepage: https://bottender.js.org
- Size: 23.9 MB
- Stars: 40
- Watchers: 6
- Forks: 13
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bottender
This repo contains the source code and documentation for [Bottender](https://github.com/Yoctol/bottender).
## Getting started
### Installation
1. clone this repo to your local machine
2. `yarn` to install the website's npm dependencies.
### Running locally
1. `yarn run dev` to start the dev server ([powered by Gatsby](https://www.gatsbyjs.org/))
2. `open http://localhost:8000` to open the site
## Contributing
### Create a branch
1. `git checkout source` in your local repo
2. `git pull origin source` to ensure you have the latest main code
3. `git checkout -b the-name-of-my-branch` to create a branch (remember to replace `the-name-of-my-branch` with a suitable name)
### Make the change
1. Changes to React components in `src` will hot-reload
2. Changes to markdown files in `content` will hot-reload
3. If working with plugins, you may need to remove the `.cache` directory and restart the server.
### Test the change
1. Run `yarn run lint` from the project root. Make sure it pass the check.
2. If possible, test any visual changes in all latest version of common browsers, on both desktop and mobile.
### Push it
1. `git add -A && git commit -m "My message"` (replacing `My message` with a commit message, such as `Fixed header logo on Android`) to stage and commit your changes
2. `git push my-fork-name the-name-of-my-branch`
3. Make a pull-request
### Troubleshooting
- `yarn reset` to clear the local cache
- `rm -rf node_modules && yarn` to reinstall the dependencies