Skip to content

Commit

Permalink
feat(release): v10 release 🎉
Browse files Browse the repository at this point in the history
  • Loading branch information
slvnperron committed Jun 19, 2018
1 parent 7349e7f commit 536c297
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 53 deletions.
28 changes: 5 additions & 23 deletions README.md
Expand Up @@ -7,16 +7,10 @@

Botpress is an open-source bot creation tool written in JavaScript. It is powered by a rich set of open-source modules built by the community. We like to say that **Botpress is like the WordPress of Chatbots**; anyone can create and reuse other people's modules.

---

### 📍 This version (Botpress X) is still in beta. See [this branch](https://github.com/botpress/botpress/tree/archive/1.1) for the latest stable archive.

---

##### Learn Botpress

| 📖 [v10 **Documentation**](https://botpress.io/docs/beta/) |
| ---------------------------------------------------------- |
| 📖 [v10 **Documentation**](https://botpress.io/docs) |
| ---------------------------------------------------- |


##### Follow us
Expand Down Expand Up @@ -46,7 +40,7 @@ Botpress is on a mission to make useful bots ubiquitous by powering developers w
Botpress requires [Node.js](https://nodejs.org) (version >= 8.2) and uses [npm](https://www.npmjs.com) as package manager.

```
npm install -g botpress@beta
npm install -g botpress
```

## Creating a bot
Expand All @@ -63,44 +57,32 @@ Once your bot is created, you need to run [`botpress start`](https://botpress.io
botpress start
```

This will provide you locally a web interface available at **`http://localhost:3000`**
This will provide you with a web interface available at **`http://localhost:3000`** and a chat window at **`http://localhost:3000/s/chat`**

## Contributing

Thank you for your interest in Botpress. Here are some of the many ways to contribute.

* Check out our [contributing guide](/.github/CONTRIBUTING.md)
* Check misspelling in our docs.
* Look at our [code of conduct](/.github/CODE_OF_CONDUCT.md)
* Engage with us on Social Media
* Follow us on [Twitter](https://twitter.com/getbotpress)
* Like us on [Facebook](https://www.facebook.com/botpress)
* Join our channel on [Slack](https://slack.botpress.io)
* Answer and ask questions on the Slack community
* [Write and edit the documentation](/.github/CONTRIBUTING.md)
* Check misspelling in our docs.

For starters, there are some open issues with the [first good issue][starter-label] tag which are ideal for starting to contribute. They are all relatively easy to get started with.

Contributions to Botpress will be dual-licensed under AGPLv3 and the Botpress Proprietary License. This means that all contributors need to agree to the dual-license before their contributions can be accepted.

Please follow the [Conventional Commits](https://conventionalcommits.org/) specs when doing commits. **Pull requests not respecting this commit style will be rejected.**

## Community

There's a [Slack community](https://slack.botpress.io) where you are welcome to join us, ask any question and even help others.

Get an invite and join us now! 👉 [https://slack.botpress.io](https://slack.botpress.io)

## Development steps

To modify, test or create modules, please install [lerna](https://github.com/lerna/lerna).

Then run `lerna bootstrap`. This will initialize all modules and link them (using `yarn link`). Then in your bot, use `yarn link @botpress/module-name` to use the local version of that module.

## Publishing changes (Botpress team only)

Run `./push-changes.sh`

## License

Botpress is dual-licensed under [AGPLv3](/licenses/LICENSE_AGPL3) and the [Botpress Proprietary License](/licenses/LICENSE_BOTPRESS).
Expand Down
2 changes: 1 addition & 1 deletion docs/buildspec.yml
Expand Up @@ -25,7 +25,7 @@ phases:
- aws s3 sync reference/ s3://botpress-docs/$PACKAGE_VERSION/reference

# Build for $GITHUB_BRANCH
- export PACKAGE_VERSION=$(if [ -z ${GITHUB_BRANCH+x} ]; then echo "beta"; else echo "$GITHUB_BRANCH"; fi)
- export PACKAGE_VERSION=$(if [ -z ${GITHUB_BRANCH+x} ]; then echo "latest"; else echo "$GITHUB_BRANCH"; fi)
- echo "******* Building Jekyll site (version $PACKAGE_VERSION) *******"
- 'printf "baseurl: /docs/$PACKAGE_VERSION\nbotpress_version: $PACKAGE_VERSION" > _config.prod.yml'
- make build-production
Expand Down
28 changes: 0 additions & 28 deletions package_backup.json

This file was deleted.

2 changes: 1 addition & 1 deletion push-changes.sh
@@ -1,4 +1,4 @@
cd `dirname $0`
./node_modules/.bin/lerna bootstrap
./node_modules/.bin/lerna run compile
./node_modules/.bin/lerna publish --force-publish=* --npm-tag=beta --conventional-commits
./node_modules/.bin/lerna publish --force-publish=* --conventional-commits

0 comments on commit 536c297

Please sign in to comment.