Proffy: A TypeScript repository from GhostDovahkiin

Online teaching platform made with React.js using Typescript 🚀

Content

Getting Started
- Cloning
- Requirements
  - Web
  - Server
- Running
Issues
- Report
- ~~Trouble Shooting~~
Contributing
Todo
License

Getting Started 🚀

Cloning

# Clone the repository using git
$ git clone https://github.com/ghostdovahkiin/Proffy.git

# Access the project folder
$ cd proffy

Requirements

Node.js
Yarn or npm

Web

This project use third party dependencies that need to be installed, use that command to install all needed dependencies

$ cd web
$ yarn install

The above command will install all third party dependencies used. If you want to install manually all the dependencies follow the steps bellow

# Entering in web directory
$ cd web

# Installing depencies
$ yarn add @types/react-router-dom -D
$ yarn add axios

To start the server you need the database, to make migrations use the command:

$ yarn knex:migrate

The above command is a custom command made on package.json file. (Ln 8, Col 5)

Server

This project use third party dependencies that need to be installed, use that command to install all needed dependencies

$ cd server
$ yarn install

The above command will install all third party dependencies used. If you want to install manually all the dependencies follow the steps bellow

# Entering in server directory
$ cd server

# Installing depencies
$ yarn add @types/cors -D
$ yarn add @types/express -D
$ yarn add ts-node-dev -D
$ yarn add knex

# Proffy Version 2.0
$ yarn add pg
$ yarn add dotenv

Running

To start the Web Server run the command

# Entering in web directory
$ cd web

# Run the web server
$ yarn start

To start the Back Server run the command

# Entering in Server directory
$ cd server

# Run the Back Server
$ yarn start

Issues 🐛

Report

In case you are having any problem do not be shy to report to us in Issues session.

Contributing 🤝

There are many forms to contribute with the project, first of all you can give this github repo a Star.

If you want do help with the code follow the steps bellow

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.
$ gh repo fork ghostdovahkiin/Proffy

# Clone your fork
$ git clone {your-fork-url}
$ cd proffy

# Create a branch with your feature
$ git checkout -b {branch-name}

# Make the commit with your changes
$ git commit -m 'Feat: {feature-name}'

# Send the code to your remote branch
$ git push origin {branch-name}

Then send a Pull Request that will be analyzed and approved if it helps with the project

License 📝

This project is under the MIT license. See the LICENSE for more information.

GhostDovahkiin/Proffy