https://github.com/christiancesar/my-university-oop
Fundamentals of OOP, implementation of university management domain classes. Concepts applied to Software Engineering.
https://github.com/christiancesar/my-university-oop
Last synced: 4 months ago
JSON representation
Fundamentals of OOP, implementation of university management domain classes. Concepts applied to Software Engineering.
- Host: GitHub
- URL: https://github.com/christiancesar/my-university-oop
- Owner: christiancesar
- Created: 2024-08-28T14:03:35.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-02-20T17:46:46.000Z (5 months ago)
- Last Synced: 2025-02-20T18:42:40.525Z (5 months ago)
- Language: TypeScript
- Size: 225 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# My University
O objetivo do projeto é apresentar os Fundamentos da Engenharia de Software, dando aos alunos a percepção da evolução após terem concluído uma avaliação de requisitos funcionais e não funcionais.
O próximo passo é usar diagramas de classes e casos de uso para codificação futura, testes e padrões de design e arquitetura, aplicando assim todos os conceitos básicos da Engenharia de Software.
## Para rodar o projeto (Windows)
### Requisitos
Metodo 1:
- [Node.js](https://nodejs.org/en/) Faça o download e instale o Node.js
- [Git](https://git-scm.com/) Faça o download e instale o Git
- [Visual Studio Code](https://code.visualstudio.com/) Faça o download e instale o Visual Studio Code
- [Windows Terminal](https://www.microsoft.com/pt-br/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab)
- Você pode baixar facilmente na Microsoft Store a maioria destes programas.
Metodo 2:
- [Instalação Automatizada](https://github.com/christiancesar/setup-env-development) Baixe o repositorio clicando em `Code`, descopacte o arquivo zip e execute o arquivo `step-one.ps1` ao finalizar a instalação execute `step-two.ps2`, todos como administrador.
### Baixar e rodar o projeto
Método 1:
- Crie uma pasta dentro do seu diretório de preferência. Exemplo: `Documentos/Projetos`
- Dentro da pasta `Projetos` clique com o botão direito do mouse e selecione a opção `Abir no terminal`
- Ao abrir o terminal, execute o comando `git clone https://github.com/christiancesar/my-university-oop.git`
- Após o download do projeto, execute o comando `cd my-university-oop`
- Execute o comando `npm install`
- Execute o comando `npm dev`
- Pronto! o projeto estará rodando e mostrará informações em seu terminal.
- Para acessar os codigos do projeto para que você pode visualizar e editar, abra o Visual Studio Code e clique em `Arquivo > Abrir Pasta` e selecione a pasta `my-university-oop` que foi baixada. Ou ainda em seu terminal execute o comando `code .` o projeto será aberto no Visual Studio Code.
Método 2:
- Baixe o projeto em https://github.com/christiancesar/my-university-oop.git, no repositorio clique em Code e faça o download do arquivo zip.
- Descompacte o arquivo zip em uma pasta de sua preferência.
- Dentro da pasta onde o projeto foi descompactado clique com o botão direito do mouse e selecione a opção `Abir no terminal`, irá abrir no diretorio do projeto.
- Execute o comando `npm install`
- Execute o comando `npm dev`
- Pronto! o projeto estará rodando e mostrará informações em seu terminal.
- Para acessar os codigos do projeto para que você pode visualizar e editar, abra o Visual Studio Code e clique em `Arquivo > Abrir Pasta` e selecione a pasta `my-university-oop` que foi baixada. Ou ainda em seu terminal execute o comando `code .` o projeto será aberto no Visual Studio Code.
## Diagrama de Classes
O diagrama de classes é uma representação gráfica das classes de um sistema e dos relacionamentos entre elas. Ele é um dos diagramas mais populares da UML e é usado para modelar a estrutura de um sistema.
## Organização do Projeto
- `src/` - Diretório onde se encontra os arquivos de código fonte do projeto.
- `src/entities/` - Diretório onde se encontra as classes de entidades do projeto.
- `src/entities/inheritance-examples/` - Diretório onde se encontra os mais exemplos de herança.
- `src/factories/` - Diretório onde se encontra as classes de fábricas do projeto.
- `src/repositories/` - Diretório onde se encontra as classes de repositórios do projeto.
- `src/seeds/` - Diretório onde se encontra as classes de sementes do projeto.
- `tests/` - Diretório onde se encontra os arquivos de testes do projeto.