https://github.com/curiouslearner/nexus
Streamline & automate the boring parts
https://github.com/curiouslearner/nexus
Last synced: about 1 year ago
JSON representation
Streamline & automate the boring parts
- Host: GitHub
- URL: https://github.com/curiouslearner/nexus
- Owner: CuriousLearner
- Created: 2018-07-17T18:10:47.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-02T02:42:37.000Z (almost 2 years ago)
- Last Synced: 2025-05-07T10:15:13.414Z (about 1 year ago)
- Language: Python
- Size: 171 KB
- Stars: 11
- Watchers: 4
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
nexus
==============================
[](https://codecov.io/gh/CuriousLearner/nexus)
__Version:__ 0.0.0
Streamline & automate the boring parts
## Getting up and running
Minimum requirements: **pip, fabric, python3, redis & [postgres][install-postgres]**, setup is tested on Mac OSX only.
```
brew install postgres python3
[sudo] pip install fabric
```
[install-postgres]: http://www.gotealeaf.com/blog/how-to-install-postgresql-on-a-mac
In your terminal, type or copy-paste the following:
git clone git@github.com:CuriousLearner/nexus-web.git; cd nexus-web; fab init
Go grab a cup of coffee, we bake your hot development machine.
Useful commands:
- `fab serve` - start [django server](http://localhost:8000/)
- `fab deploy_docs` - deploy docs to server
- `fab test` - run the test locally with ipdb
**NOTE:** Checkout `fabfile.py` for all the options available and what/how they do it.
## Deploying Project
The deployment are managed via travis, but for the first time you'll need to set the configuration values on each of the server.
Check out detailed server setup instruction [here](docs/backend/server_config.md).
## How to release nexus
Execute the following commands:
```
git checkout master
fab test
bumpversion patch # 'patch' can be replaced with 'minor' or 'major'
git push origin master
git push origin master --tags
git checkout qa
git rebase master
git push origin qa
```
## Contributing
Golden Rule:
> Anything in **master** is always **deployable**.
Avoid working on `master` branch, create a new branch with meaningful name, send pull request asap. Be vocal!
Refer to [CONTRIBUTING.md][contributing]
[contributing]: http://github.com/CuriousLearner/nexus-web/tree/master/CONTRIBUTING.md