/site-secretaria-educacao-rioclaro

Repository with the website developed for Education Department of Rio Claro City Hall in the State of Rio Janeiro.

Primary LanguageTypeScript

Site - Secretaria de Educação de Rio Claro

Code quality GitHub last commit GitHub repo size GitHub branch checks state

Overview

  • Feature 1
  • Feature 2
  • Feature 3
  • [Need to be listed]
See Demonstration

Project Requirements

Make sure that you also have NodeJS and NPM installed on your computer.

  • $ node --version and $ npm --version

Also make sure you have Angular CLI and Firebase CLI installed globally on your machine.

  • $ npm install -g @angular/cli firebase-tools

Install dependencies of project with:

  • $ npm install

First run - Environment files

In the first execution of the project, it is essential to create the environment files (environment.ts and environment.prod.ts) in /src/environments according to the model that follows inside the folder (environment.example.ts).


Project Requirements

Make sure that you also have NodeJS and NPM installed on your computer.

  • $ node --version and $ npm --version

Install dependencies of project with:

  • $ npm install

Angular Cli is already part of the development dependencies, so any cli functionality can be used with the prefix npx.

  • $ npx ng serve

First Execution - Environment files: In the first execution of the project, it is essential to create the environment files (environment.ts) in /src/environments according to the model that follows inside the folder (environment.exp.ts).


Workflow

WORKFLOW.md - This project uses the workflow pattern called git flow.


Tests

[Need to be implemented]


Deploy

GITHUB ACTIONS - To deploy to a demonstration of project hosted in GitHub Pages.


Contributing

CONTRIBUTING.md - Specifications of how the contribution should be submitted


Changelog

CHANGELOG.md - Chronologically list of changes for each version of a project