Awesome Open Source
Awesome Open Source

Rin Minase's Anime Database

Circle-CI Netlify-Status

David-DM David-DM

Angular Node

Introduction

Add info here

Getting Started

Running the project

Installations Required:

  1. Clone the project and copy the ENV template file to a new ENV file.

    git clone https://github.com/RinMinase/anidb.git
    cd anidb
    cp .env.example .env
    
  2. Modify the created ENV file based on your Firebase configuration

  3. Install the dependencies then run the project

    yarn install
    yarn start
    
  4. Fire up your browser and go to localhost:3000

Building the project

Installations Required:

  1. Fire up your terminal inside the project folder.

  2. Build the project by running:

    yarn build
    
  3. This should generate a dist/ folder inside the project folder.

Code Scaffolding

This is using yarn ng generate <schematic> <name> command. This can be shortened to yarn ng g <schematic> <name>.

Schematics

Project Structure

.
โ”œโ”€โ”€ .circleci/                          # Circle CI configuration folder
โ”œโ”€โ”€ assets/                             # Project assets
โ”‚   โ”œโ”€โ”€ config/                         # Project configurations
โ”‚   โ”‚   โ”œโ”€โ”€ manifest.json               # Web manifest file
โ”‚   โ”‚   โ”œโ”€โ”€ ngsw-config.json            # PWA Service Worker configuration file
โ”‚   โ”‚   โ”œโ”€โ”€ webpack.ts                  # Extended webpack configuration file
โ”‚   โ”‚   โ””โ”€โ”€ ...                         # Other configuration files
โ”‚   โ”œโ”€โ”€ res/                            # Platform-specific resources folder
โ”‚   โ””โ”€โ”€ ...                             # Other assets
โ”œโ”€โ”€ dist/                               # Compiled production code
โ”œโ”€โ”€ src/                                # Project source code
โ”‚   โ”œโ”€โ”€<module-name>/                   # Project module
โ”‚   โ”‚   โ”œโ”€โ”€ <name>.component.html       # Component template
โ”‚   โ”‚   โ”œโ”€โ”€ <name>.component.scss       # Component stylesheet
โ”‚   โ”‚   โ”œโ”€โ”€ <name>.component.ts         # Module component
โ”‚   โ”‚   โ””โ”€โ”€ <name>.module.ts            # Module
โ”‚   โ”œโ”€โ”€ core/                           # Project-wide reusable classes
โ”‚   โ”‚   โ”œโ”€โ”€ builders/                   # Project builders
โ”‚   โ”‚   โ”œโ”€โ”€ components/                 # Project components
โ”‚   โ”‚   โ””โ”€โ”€ services/                   # Project services
โ”‚   โ”œโ”€โ”€ app.module.ts                   # Main module and project routes
โ”‚   โ”œโ”€โ”€ index.html                      # Main HTML file
โ”‚   โ”œโ”€โ”€ index.scss                      # Main Stylesheet (SCSS) file
โ”‚   โ””โ”€โ”€ index.ts                        # Main TypeScript file
โ”œโ”€โ”€ .editorconfig                       # IDE / Editor configuration
โ”œโ”€โ”€ .env                                # Environment file
โ”œโ”€โ”€ angular.json                        # Angular CLI configuration
โ”œโ”€โ”€ tsconfig.json                       # Main TypeScript configuration file
โ””โ”€โ”€ ...                                 # Other project files

Project tasks

Task automation is based on Yarn scripts or NPM scripts.

Task Description
yarn start Run development server on http://localhost:3000/ with file watching on changes
yarn start --prod Run production server on http://localhost:3000/ with file watching on changes
yarn build Build production code and add service worker to built code

Other tasks included in package.json that should not be executed manually:

Task Description
yarn deploy Build production code without displaying progress and add service worker to built code

Testing the project

Add info here

Built with

Deployed to

Alternatives To Anidb
Select To Compare


Alternative Project Comparisons
Related Awesome Lists
Top Programming Languages

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Typescript (282,558)ย 
Angular (54,939)ย 
Firebase (21,950)ย 
Scss (21,439)ย 
Ci (12,679)ย 
Netlify (5,249)ย 
Anime (3,056)ย 
Circleci (2,776)ย 
Service Worker (2,055)ย 
Bootstrap5 (1,299)ย 
Angular12 (81)ย 
Anidb (23)ย