Portal Jabar - Content Management System

This is the main codebase for Portal Jabar - Content Management System

 

Docs

• Codebase
  • Technologies
  • Folder Structure
• First time setup
• Running locally
• Code style guide

 

Codebase

Technologies

Here is a list of all the core technologies this project use:

• npm: Package manager
• Tailwind CSS: CSS framework for styling
• Jabar Design System: UI components
• Vue.js: JavaScript framework for building user interfaces

 

Folder Structure

├── .git                  # all github actions workflow
│   └── ...
├── .husky                # all husky configuration and scripts
│   └── ...
├── dist                  # build directory
│   └── ...
├── public                # public directory
│   └── ...
├── src
│   ├── assets            # contains static assets such as fonts, logos, images, etc
│   ├── common            # contains reusable constants, components, functions, etc
│   ├── components        # contains app components
│   ├── layouts           # contains page layouts
│   ├── pages             # contains application views and routes
│   ├── plugins           # contains custom Vue.js functionality
│   ├── repositories      # contains all API endpoints, methods, etc
│   ├── router            # contains all app routes, navigation guards, etc
│   └── store             # contains vuex store, modules, etc
└── tests
    ├── helpers           # contains test helpers
    └── unit              # contains component's unit test

 

First time setup

The first step to running Portal Jabar CMS locally is downloading the code by cloning the repository:

git clone https://github.com/jabardigitalservice/portal-jabar-cms.git

#or using SSH
git clone git@github.com:jabardigitalservice/portal-jabar-cms.git

open portal-jabar-cms directory

cd portal-jabar-cms

create env file

cp .env.example .env

install the dependencies

npm install

 

Running locally

Compiles and hot-reloads for development

# Make sure all the credentials are filled in the .env file

# you can run the app locally for development
$ npm run serve

# or compiles and minifies for production
$ npm run build     

 

Code Style Guide

• Javascript Style Guide by Airbnb (https://github.com/airbnb/javascript#airbnb-javascript-style-guide-)