Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crowdbotics-apps/cpayto-23614
This django application was built with Crowdbotics www.crowdbotics.com
https://github.com/crowdbotics-apps/cpayto-23614
Last synced: 6 days ago
JSON representation
This django application was built with Crowdbotics www.crowdbotics.com
- Host: GitHub
- URL: https://github.com/crowdbotics-apps/cpayto-23614
- Owner: crowdbotics-apps
- Created: 2020-12-30T20:53:41.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-30T20:54:48.000Z (almost 4 years ago)
- Last Synced: 2024-08-02T20:44:36.236Z (3 months ago)
- Language: Python
- Size: 37.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cpayto_23614
This is a repository for a web application developed with Django, built with [Crowdbotics](https://crowdbotics.com)
### Features
1. **Local Authentication** using email and password with [allauth](https://pypi.org/project/django-allauth/)
2. **Rest API** using [django rest framework](http://www.django-rest-framework.org/)
3. **Forgot Password**
4. Bootstrap4
5. Toast Notification
6. Inline content editor in homepage
# Development
Following are instructions on setting up your development environment.
The recommended way for running the project locally and for development is using Docker.
It's possible to also run the project without Docker.
## Docker Setup (Recommended)
This project is set up to run using [Docker Compose](https://docs.docker.com/compose/) by default. It is the recommended way. You can also use existing Docker Compose files as basis for custom deployment, e.g. [Docker Swarm](https://docs.docker.com/engine/swarm/), [kubernetes](https://kubernetes.io/), etc.
1. Install Docker:
- Linux - [get.docker.com](https://get.docker.com/)
- Windows or MacOS - [Docker Desktop](https://www.docker.com/products/docker-desktop)
1. Clone this repo and `cd cpayto_23614`
1. Make sure `Pipfile.lock` exists. If it doesn't, generate it with:
```sh
$ docker run -it --rm -v "$PWD":/django -w /django python:3.7 pip3 install --no-cache-dir -q pipenv && pipenv lock
```
1. Use `.env.example` to create `.env`:
```sh
$ cp .env.example .env
```
1. Update `.env` and `docker-compose.override.yml` replacing all ``
1. Start up the containers:
```sh
$ docker-compose up
```
This will build the necessary containers and start them, including the web server on the host and port you specified in `.env`.
Current (project) directroy will be mapped with the container meaning any edits you make will be picked up by the container.
1. Seed the Postgres DB (in a separate terminal):
```sh
$ docker-compose exec web python3 manage.py makemigrations
$ docker-compose exec web python3 manage.py migrate
```
1. Create a superuser if required:
```sh
$ docker-compose exec web python3 manage.py createsuperuser
```
You will find an activation link in the server log output.
## Local Setup (Alternative to Docker)
1. [Postgresql](https://www.postgresql.org/download/)
2. [Python](https://www.python.org/downloads/release/python-365/)
### Installation
1. Install [pipenv](https://pypi.org/project/pipenv/)
2. Clone this repo and `cd cpayto_23614`
3. Run `pip install --user --upgrade pipenv` to get the latest pipenv version.
4. Run `pipenv --python 3.6`
5. Run `pipenv install`
6. Run `cp .env.example .env`
7. Update .env file `DATABASE_URL` with your `database_name`, `database_user`, `database_password`, if you use postgresql.
Can alternatively set it to `sqlite:////tmp/my-tmp-sqlite.db`, if you want to use sqlite for local development.
### Getting Started
1. Run `pipenv shell`
2. Run `python manage.py makemigrations`
3. Run `python manage.py migrate`
4. Run `python manage.py runserver`