Rin Minase's Anime Database (Angular JS)

Introduction

Add info here

Getting Started

Creating and cloning the project

Add info here

Project Structure

Directory Structure

.
├── .circleci/                    # Circle CI folder
│   └── config.yml                # Circle CI configuration file
├── .tmp/                         # Local development server 
├── dist/                         # Local production server
├── src/                          # Project source code
│   ├── app/                      # Project components
│   │   ├── core/                 # System-wide components
│   │   │   ├── constants/        # Project constants
│   │   │   ├── directives/       # Project directives
│   │   │   └── services/         # Project services
│   │   │       └── builders/     # Project builders
│   │   ├── modules/              # Project modules
│   │   │   └── <module-name>     # Module folder (refer to structure below)
│   │   ├── index.config.js       # Configuration file for main module
│   │   └── index.module.js       # Main module
│   ├── assets/                   # Project assets
│   │   ├── firebase/             # Firebase configurations
│   │   ├── gulp/                 # Gulp files
│   │   ├── styles/               # Stylesheet folder 
│   │   │   └── chunks/           # Stylesheet modules
│   │   ├── testing/              # Testing asets
│   │   │   └── tests/            # Unit tests
│   │   ├── .env                  # Environment variables
│   │   ├── .env.example          # Environment variables template
│   │   ├── favicon.ico           # Wepage icon
│   │   └── robots.txt            # Robots file
│   ├── res/                      # Cordova resources folder
│   │   └── android/              # Android resources
│   │       ├── hooks/            # Android build hooks
│   │       ├── icon/             # Android icons
│   │       └── screen/           # Android splash screens
│   └── index.html                # Main HTML file
├── .editorconfig                 # IDE / Editor configuration
├── .eslintrc                     # JS linting configuration
├── .firebaserc                   # Firebase project configuration
├── .sasslintrc                   # SCSS linting configuration
├── .travis.yml                   # Travis deployment configuration
├── config.xml                    # Cordova build configuration
├── firebase.json                 # Firebase hosting configuation
├── gulpfile.js                   # Main gulp file
└── ...                           # Other project files

Module Structure

.
├── <sub-module name>      # Sub-module
│    └── ...               # Sub-module files
├── <name>.controller.js   # Module controller
├── <name>.html            # Module template
├── <name>.module.js       # Module
└── <name>.scss            # Module stylesheet

Building the project

Add info here

Bundling the project for Android

Add info here

Deploying the project to Firebase

Add info here

Project tasks

Task automation is based on Gulp tasks, Yarn scripts and NPM scripts.

Task	Description
gulp serve or yarn start	Run development server on http://localhost:3000/ with file watching on changes
gulp serve:dist or yarn run build	Run test server on http://localhost:3000/
gulp build or gulp
yarn test <args>
yarn run bundle
yarn run deploy
yarn run setup
yarn run setup-android
yarn run setup-testing

Testing the project

Add info here

Built with

• AngularJS - Web Framework
• Babel ES9 / ES2018 Preset - Syntax and compiler
• Sassy CSS (SCSS) - CSS pre-processor
• Bootstrap 4 - HTML Framework (layout)
• Firebase - Database
• Gulp 4 - Task runner
• Webpack 4 - Project bundler
• Cordova - Android APK bundler
• NightwatchJS - Testing Framework
• Circle CI - Continuous Integration (CI) service
• Yarn - Package Manager