Elmer

A social network inspired by reddit
Explore the app »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Screenshots
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

An open source social network inspired by reddit built with Python using the Django Web Framework, trivial templates with Bootstrap & jQuery for UI & UX, a RESTful API for the web client using Django Rest Framework. I have designed & developed the Progressive Web App using React.js & Redux.

Built With

• Python 3.6.x
• Django Web Framework 2.1.x
• Django Rest Framework 3.8.x
• Twitter Bootstrap 4.x
• jQuery 3.x

Screenshots

Check the website at https://elmer.pythonanywhere.com

Welcome Page

Home Page

Post Detail Page

Profile Page

Create Post Page

Getting Started

Prerequisites

• Python 3.6.x

Installation

Create new directory:

$ mkdir elmer && cd elmer

Create new virtual environment:

$ python -m venv venv

Activate virtual environment:

$ source venv/bin/activate  (For Linux)
$ venv/Scripts/activate  (For Windows)

Clone this repository:

$ git clone https://github.com/thetruefuss/elmer.git src && cd src

Install requirements:

$ pip install -r requirements.txt

Copy environment variables:

$ cp .env.example .env

Load static files:

$ python manage.py collectstatic --noinput

Check for any project errors:

$ python manage.py check

Run Django migrations to create database tables:

$ python manage.py migrate

Load initial data for flatpages from fixtures folder:

$ python manage.py loaddata fixtures/flatpages_data.json

Populate the database with dummy data (Optional):

$ python scripts/populate_database.py

Run the development server:

$ python manage.py runserver

Verify the deployment by navigating to http://127.0.0.1:8000 in your preferred browser.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a pull request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Send me an email to alisheikh1114@gmail.com
Find me online: LinkedIn • Twitter • Facebook • Instagram • Portfolio