Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grupyrn/jararaca
GruPy-RN Event and Check-in System
https://github.com/grupyrn/jararaca
django event-management python
Last synced: 2 months ago
JSON representation
GruPy-RN Event and Check-in System
- Host: GitHub
- URL: https://github.com/grupyrn/jararaca
- Owner: grupyrn
- License: gpl-3.0
- Created: 2018-08-06T11:44:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-22T14:42:38.000Z (over 1 year ago)
- Last Synced: 2024-08-01T19:51:24.340Z (5 months ago)
- Topics: django, event-management, python
- Language: Python
- Homepage: https://meetup.grupyrn.org
- Size: 1.34 MB
- Stars: 31
- Watchers: 6
- Forks: 20
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jararaca
GruPy-RN Event and Check-in System
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
What things you need to install the software and how to install them
- Python 3.6+
- Node/NPM/Yarn
### Installing
A step by step series of examples that tell you how to get a development env running
First of all, make a copy of `.env.sample` to `.env`
```
cp .env.sample .env
```
Install the dependencies
```
pip install -r requirements.txt
```
Checkout [Jararaquinha](https://github.com/grupyrn/jararaquinha) submodule
```
git submodule init
git submodule update
```
Then, refer to [Jararaquinha's installation instructions](https://github.com/grupyrn/jararaquinha#installing).
### Running
Enter in your virtual environment.
Apply the migrations
```
python manage.py migrate
```
Create admin user
```
python manage.py createsuperuser
```
Compile translations
```
python manage.py compilemessages -f
```
Run the project
```
python manage.py runserver
```
And also run [Jararaquinha](https://github.com/grupyrn/jararaquinha) in another terminal
```
yarn start
```
Now you can open [http://localhost:8000](http://localhost:8000) in your browser
## Built With
- [Django](https://www.djangoproject.com/)
- [Django REST Framework](http://www.django-rest-framework.org/)
- [PyQRCode](https://pythonhosted.org/PyQRCode/)
- [Pillow](https://pillow.readthedocs.io/en/stable/)
- [SendGrid API](https://sendgrid.com/)
- [React](https://reactjs.org/)
## Contributing
### Steps for Submitting Code
1. Fork the repository on GitHub.
2. Make your change.
3. Send a GitHub Pull Request to the main repository’s `master` branch. GitHub Pull Requests are the expected method of code collaboration on this project.
### Translate
1. Prepare message files for the desired language.
```
python manage.py makemessages --locale
```
Example:
```
python manage.py makemessages --locale pt_BR
```
2. Translate the \*.po files inside each project application /locale//LC_MESSAGES/
3. Compile messages
```
python manage.py compilemessages -f
```