HIRING EMPLOYEES SYSTEM FOR FARMERS
Docs

Report Bug · Request Feature

Table of Contents

1. ER Diagram
2. Contributors
3. About The Project
   • Built With
4. Getting Started
   • Prerequisites
   • Installation
   • Run Project
   • Deploy Project
5. Roadmap
6. CI/CD Rules

ER Diagram

• file documentation/Farm Employee ER.drawio

Contributors

• Ελευθερία Ντούλια Α.Μ.: 3180129
• Πελαγία Ροδίτη Α.Μ.: 3190346
• Ηλίας Θεοφάνης Γραββάνης Α.Μ.: 3200248

About The Project

Git configuration for Windows

git config core.ignorecase false

Development Brach and working with Pull Request (https://github.com/iliophanis/farm-employee)

develop

Release Branch and Working with merge from develop branch

master

Swagger Server Documentation

Swagger Endpoint in Dev http://localhost:5000/swagger/

![Documents Screen Shot][product-screenshot]

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section.

• Next.js
• React Query
• Recoil
• Tailwind Css
• .NET
• Entity-Framework MySQL

(back to top)

Getting Started

This is instructions on setting up your project locally. To get a local copy up and running follow these steps.

Prerequisites

Install dotnet 6 sdk - SDK 6.0.407 (The latest)

• https://dotnet.microsoft.com/en-us/download/dotnet/6.0

Installl latest node - npm and yarn globally ,also if need upate node version minimum 15.0.0.

• https://nodejs.org/en - LTS Version

• yarn

  npm install -g yarn

Project Installation

client

1. yarn install
2. yarn dev

server

1. dotnet restore
2. dotnet watch run

server db scaffolding

• .net scaffold docs

 dotnet ef dbcontext scaffold "Server=localhost;User=root;Password=;Database=farm_employee" "Pomelo.EntityFrameworkCore.MySql" --context DataContext --context-dir Data --output-dir .\Data\Entities\ --no-onconfiguring

TODO

(back to top)

Run Project

TODO

(back to top)

Deploy Project

TODO

(back to top)

Roadmap

• Add ER diagram in flowchart
• Business Requirements - Use cases of project
• Add clickup for Agile - Set ticketing system , sprints
• Create Template for backend , frontend
• Deploy - Testing (Unit - E2E)
• Add Changelog (i.e Version sections with break changes in description)

See the open issues for a full list of proposed features (and known issues).

(back to top)

CI CD Rules

1. Clone the Project
2. Create your Branch

• feature (git checkout -b feature/{TickectName}) - Add new functionality in project
• bug (git checkout -b bug/{TickectName}) - The bug which needs to be fixed soon
• wip (git checkout -b wip/{TickectName}) - The work is in progress, and I am aware it will not finish soon

3. Commit your Changes (git commit -m '{message}')
4. Push to the Branch (git push origin feature/{TickectName})
5. Open a Pull Request

(back to top)

EmailService Provider

Development Environment

• website : https://ethereal.email/
• smtp : smtp.ethereal.email
• port : 587
• name : lexus.mckenzie@ethereal.email
• password: TYbtnjxdXaUTypy8mP

Production Environment

• website : https://mail.google.com/
• port : 465
• smtp : smtp.gmail.com
• name : lexus.mckenzie@ethereal.email
• password: TYbtnjxdXaUTypy8mP