Giter Club home page Giter Club logo

small's Introduction

Small is a simple blogging application, similar to Medium. It will let users write little blog posts which will all be shared on the main page.

I have followed the structure on https://testdriven.io but have not focussed on the tests and have used APIStart rather than Flask.

This application has the following services:

  1. users - manage users and authentication
  2. client - client-side React application
  3. posts - manager user posts
  4. gateway - a proxy to run the applications under the same domain

Tools

  • APIStar
  • React
  • Nginx
  • Docker

Environment configuration

This application is production ready. The following environment variables are required for each service.

############
# FRONTEND #
############
REACT_APP_USERS_SERVICE_BASE_URL=
REACT_APP_POSTS_SERVICE_BASE_URL=

############
# USERS    #
############
JWT_SECRET=jwt_secret
DATABASE_URL=postgres_database_url

############
# POSTS    #
############
DATABASE_URL=

In development, also include the following environment variables

############
# FRONTEND #
############
LOCAL_DEV=True


#################
# POSTS & USERS #
#################
LOCAL_DEV=True
SETTINGS_CLASS=LocalConfiguration

Deployment

To deploy use Docker and your container orchestration technology of choice. Copy the template in docker-compose.yml to set up the containers correctly.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.