Skip to content

Sharespots - find co-working friendly cafes in London

Notifications You must be signed in to change notification settings

abu271/sharespots

 
 

Repository files navigation

Sharespots

Sharespots is a simple Django app that displays a curated list of cafes/co-working spaces to meetup and work in London.

Technology Stack

  • Backend: Python & Django
  • Front-end: SASS/HTML5/JavaScript
  • Hosting: Heroku
  • Storage: AWS S3

Software Tools Required

  1. Terminal: iTerm2 (MacOSX), Terminator (Linux) or use your preferred one.
  2. Text Editor: Sublime Text or your preferred one.
  3. Docker Desktop

Project Setup

Open iTerm2 (or your preferred terminal.)

Clone the repo:

git clone git@github.com:PolyglotDevsLondon/sharespots.git

Change directory into the sharespots directory:

cd sharespots

Download and install Docker Desktop if you haven't already.

Build the docker container (included is django, postgres, pgadmin and jupyter notebook run from django_extensions):

docker-compose -f local.yml build

Fire up the docker container:

docker-compose -f local.yml up

Open project in your web browser at:

http://0.0.0.0:8000/

You should now see the Sharespots website (but no venue data will show yet.)

Open a new iTerm2 terminal tab by pressing ⌘T (or open an additional terminal window using your preferred terminal.)

Change to your sharespots directory:

cd [your/sharespot/directory]

Load seed data:

docker-compose -f local.yml run django python manage.py loaddata seed_data.json

Set up a super user for django admin:

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

Reload your project in your web browser at

http://0.0.0.0:8000/

You should now see the Sharespots website with venues displaying.

(Optional) Open another browser tab/window and login using the superuser account you created in the django admin panel at http://0.0.0.0:8000/admin

Front End changes

  1. To install Sass

    • You can install using node package manager docker-compose -f local.yml run npm install -g sass
    • Windows: choco install sass
    • Mac OS X: brew install sass/sass/sass
  2. To build everything Front end related run npm run build

Troubleshooting

If the project doesn't work after pulling the latest changes by doing a git pull, you may need to run new database migrations:

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

Team

About

Sharespots - find co-working friendly cafes in London

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 49.8%
  • HTML 14.3%
  • CSS 14.2%
  • Shell 13.4%
  • JavaScript 4.3%
  • Dockerfile 4.0%