Skip to content

Latest commit

 

History

History
139 lines (75 loc) · 4.01 KB

README.rst

File metadata and controls

139 lines (75 loc) · 4.01 KB
Raw

ReuseRat

Sell your items, get paid.

See it live at: https://sell.reuserat.com

This repo used to be private due to security concerns. ReuseRat is no longer in business so the repo is now public.

Built with Cookiecutter Django

Please read the wiki to learn about the development process:

https://github.com/jamesaud/ReuseRat/wiki

A related AWS Lambda project for decreasing prices weekly:

https://github.com/jamesaud/ReuseRat-Lambda/blob/master/lambda_function.py

Settings

Moved to settings.

Basic Commands

Setting Up Your Users

  • To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

  • To create an superuser account, use this command:

    $ python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run manage.py test
$ coverage html
$ open htmlcov/index.html

Running tests with py.test

$ py.test

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Email Server

In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server MailHog with a web interface is available as docker container.

Container mailhog will start automatically when you will run all docker containers. Please check cookiecutter-django Docker documentation for more details how to start all containers.

With MailHog running, to view messages that are sent by your application, open your browser and go to http://127.0.0.1:8025

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Docker

See detailed cookiecutter-django Docker documentation.

Getting Set Up

$ docker-compose -f dev.yml build // Run only Once

$ docker-compose -f dev.yml up // site available at localhost:8000, localhost:8025 the test mail server

> running django commands:

$ docker-compose -f dev.yml run django python manage.py makemigrations

$ docker-compose -f dev.yml run django python manage.py migrate

$ docker-compose -f dev.yml run django python manage.py createsuperuser

Admin page:

localhost:8000/admin // Login with superuser account

Adding a new app to the project

It's a bit different than normal django process.

  1. Create a new folder in "reuserat" subfolder with the name of the new app
  2. Copy the files "reuserat/users/apps.py, reuserat/users/urls.py" to the subfolder you made.
  3. Add the app in "config/settings/common.py", under LOCAL_APPS
  4. Add the urls via "config/urls.py"
  5. Should be good to go and start writing views & templates.