Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rinminase/anidb-angularjs

📝📌 Rin Minase's Anime Database using AngularJS in ES6 compiled for Android with Cordova
https://github.com/rinminase/anidb-angularjs

android angularjs bootstrap4 cordova es6 firebase gulp4 nightwatch scss webpack4

Last synced: 8 days ago
JSON representation

📝📌 Rin Minase's Anime Database using AngularJS in ES6 compiled for Android with Cordova

Host: GitHub
URL: https://github.com/rinminase/anidb-angularjs
Owner: RinMinase
License: mit
Created: 2019-02-25T17:01:32.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2021-03-30T13:39:32.000Z (over 3 years ago)
Last Synced: 2023-02-26T08:46:30.665Z (over 1 year ago)
Topics: android, angularjs, bootstrap4, cordova, es6, firebase, gulp4, nightwatch, scss, webpack4
Language: JavaScript
Homepage:
Size: 9.84 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

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 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
│ └── ... # Sub-module files
├── .controller.js # Module controller
├── .html # Module template
├── .module.js # Module
└── .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](https://gulpjs.com/), [Yarn scripts](https://yarnpkg.com/lang/en/docs/cli/run/) and [NPM scripts](https://docs.npmjs.com/misc/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 ` | |
| `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](https://angularjs.org/) - Web Framework
* [Babel ES9 / ES2018 Preset](https://babeljs.io/) - Syntax and compiler
* [Sassy CSS (SCSS)](https://sass-lang.com/) - CSS pre-processor
* [Bootstrap 4](https://getbootstrap.com/) - HTML Framework (layout)
* [Firebase](https://firebase.google.com/) - Database
* [Gulp 4](https://gulpjs.com/) - Task runner
* [Webpack 4](https://webpack.js.org/) - Project bundler
* [Cordova](https://cordova.apache.org/) - Android APK bundler
* [NightwatchJS](http://nightwatchjs.org/) - Testing Framework
* [Circle CI](https://circleci.com/) - Continuous Integration (CI) service
* [Yarn](https://yarnpkg.com/) - Package Manager