Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/okunaorg/okuna-www-api
🕸 The Okuna website API code.
https://github.com/okunaorg/okuna-www-api
Last synced: about 1 month ago
JSON representation
🕸 The Okuna website API code.
- Host: GitHub
- URL: https://github.com/okunaorg/okuna-www-api
- Owner: OkunaOrg
- License: agpl-3.0
- Created: 2018-05-23T08:54:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T10:53:14.000Z (about 2 years ago)
- Last Synced: 2023-08-04T08:54:21.649Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 195 KB
- Stars: 39
- Watchers: 14
- Forks: 10
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://circleci.com/gh/OpenbookOrg/openbook-org-api) [](https://codeclimate.com/github/OpenbookOrg/openbook-org-api/maintainability) [](https://codeclimate.com/github/OpenbookOrg/openbook-org-api/test_coverage) [](https://github.com/carloscuesta/gitmoji)
The code for [api.open-book.org](https://api.open-book.org).
## Table of contents
- [Requirements](#requirements)
- [Project overview](#project-overview)
- [Contributing](#contributing)
+ [Code of Conduct](#code-of-conduct)
+ [License](#license)
+ [Other issues](#other-issues)
+ [Git commit message conventions](#git-commit-message-conventions)
- [Getting started](#getting-started)
## Requirements
* [Pipenv](https://github.com/pypa/pipenv)
## Project overview
The project is a [Django](https://www.djangoproject.com/start/) application.
## Contributing
There are many different ways to contribute to the website development, just find the one that best fits with your skills and open an issue/pull request in the repository.
Examples of contributions we love include:
- **Code patches**
- **Bug reports**
- **Patch reviews**
- **Translations**
- **UI enhancements**
#### Code of Conduct
Please read and follow our [Code of Conduct](https://github.com/OpenBookOrg/openbook-org-backend/blob/master/CODE_OF_CONDUCT.md).
#### License
Every contribution accepted is licensed under [AGPL v3.0](http://www.gnu.org/licenses/agpl-3.0.html) or any later version.
You must be careful to not include any code that can not be licensed under this license.
Please read carefully [our license](https://github.com/OpenBookOrg/openbook-org-backend/blob/master/LICENSE.txt) and ask us if you have any questions.
#### Other issues
We have a [keybase public channel](https://keybase.io/team/openbookorg.public) where you can talk to us!
#### Git commit message conventions
Help us keep the repository history consistent 🙏!
We use [gitmoji](https://gitmoji.carloscuesta.me/) as our git message convention.
If you're using git in your command line, you can download the handy tool [gitmoji-cli](https://github.com/carloscuesta/gitmoji-cli).
## Getting started
Clone the repository
```sh
git clone [email protected]:OpenBookOrg/openbook-org-backend.git
```
Create and configure your .env file
```bash
cp sample.env .env
nano .env
```
Install the dependencies
```bash
$ pipenv install
```
Activate the pipenv environment
```bash
pipenv shell
```
Serve with hot reload at http://127.0.0.1:8000
```bash
$ python manage.py runserver
```
#### Happy coding 🎉!