Skip to content
temandanus platform v1
JavaScript Dockerfile Shell
Branch: canary
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
svc-sarah
.gitignore
LICENSE
README.md
docker-compose.yml

README.md

Fira

Fira is a codename for temandanus web platform v1.

Tech Stacks

Fira is written in Fullstack JavaScript, both for Backend and Frontend. Our Backend are powered by Express and our Frontend are powered by Nuxt, a Vue.js library for building universal application.

Basically we are using MVC paradigm for architecting our platform, using MongoDB as our primary database, and Bulma as CSS framework.

Key stacks:

  • Express
  • MongoDB
  • Nuxt.js
  • Mongoose
  • JSON Web Token
  • Traefik
  • Microservices

All dynamic configuration are always stored in environment variables for prevent information leaking, and we are using 12factor approach in building a Web Application.

Naming conventions

To making onboarding process for new developer become harder, we use svc prefix plus some girl name that represent each service.

Basically they are fariz's ex.

svc-sarah

Sarah is responsible in handling static assets that uploaded by end user. It can be product images, project videos, or cat gifs.

Sarah is a good person, love to collect something, and good in placing things.

Getting Started

Before we dive deeper, we use "Backend for Frontend" paradigm instead of Fullstack. It means, Backend and Frontend is separated. We use microservices architecture for each backend.

Also you need to install MongoDB, Docker, and Node.js in our machine. Not so typical Indonesia's tech stack™️ for startup, because why not.

Also we use monorepo for structuring our repository infrastructure, it makes our job easier to maintain this platform at least for now.

Clone the repository

You already know this old story.

$ git clone git@github.com:temandanus/fira.git

Please always use SSH instead HTTPS, it means you should upload your SSH Public Key to GitHub.

Bootstrap development environment

Make sure you have Docker installed in your machine.

First of all, you need to setup "Swarm" mode in Docker

docker swarm init

After that you can start run this services in your machine by running this command

docker stack deploy -c docker-compose.yml temandanus

I am assuming you are on current work directory.

Basic Configuration

You need to set some setup according with your local machine. You need to take a look to .env.example file and fill it with your configuration

Testing

Per 25/07/2019 we don't have any Test suites, but in future we will writing some Unit & Integration test via Jest. That automated test are only for backend, and not have any plan for write it for backend.

Deployment

TBD

Maintainers

This platform (Fira) currently maintained by Fariz, feels free to reach him via fariz@temandanus.com

You can’t perform that action at this time.