Web Template Project

Overview

This repository contains a template for nodeJS, ReactJs projects using TypeScript.

Table of contents

• Overview
• Table of contents
• Getting Started
  • Prerequisites
  • Installing dependencies
  • Running application
• Screenshots
• Running tests
• Built With
• Author
• License

🚀 Getting Started

🚨 Prerequisites

MacOS

Install Homebrew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Install tools

brew install yarn
brew install node

Ubuntu

Configuring repository

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

Install tools

sudo apt update
sudo apt install yarn
sudo apt install nodejs

Windows

Install Chocolatey

Install tools

choco install yarn
choco install nodejs

📥 Installing dependencies

Inside the project's folder, run:

yarn

🏎 Running application

Go to the backend folder and run the following command to start the backend server

yarn dev:server

Go to the frontend folder and run the following command to start the web application

yarn start

🔬 Running tests

To run the tests go to the frontend folder and run the following command

yarn test

📷 Screenshots

🛠 Built With

• Node
• ReactJs
• Yarn
• Express
• TypeScript

🎖 Author

• Geraldo Braz - Initial work - @geraldobraz

📝 License

This project is licensed under the MIT License - see the LICENSE.md file for details