https://github.com/geraldobraz/web-template-project
This repository contains a template for nodeJS and ReactJs projects using TypeScript.
https://github.com/geraldobraz/web-template-project
nodejs reactjs styled-components typescript
Last synced: about 1 year ago
JSON representation
This repository contains a template for nodeJS and ReactJs projects using TypeScript.
- Host: GitHub
- URL: https://github.com/geraldobraz/web-template-project
- Owner: geraldobraz
- License: mit
- Created: 2020-06-24T19:45:54.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-11T00:13:39.000Z (over 5 years ago)
- Last Synced: 2023-03-07T23:04:48.131Z (over 3 years ago)
- Topics: nodejs, reactjs, styled-components, typescript
- Language: TypeScript
- Homepage:
- Size: 572 KB
- Stars: 18
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Web Template Project
## Overview
*This repository contains a template for nodeJS, ReactJs projects using TypeScript.*
## Table of contents
* [Overview](#Overview)
* [Table of contents](#table-of-contents)
* [Getting Started](#🚀-getting-started)
* [Prerequisites](#🚨-prerequisites)
* [Installing dependencies](#📥-installing-dependencies)
* [Running application](#🏎-running-application)
* [Screenshots](#📷-screenshots)
* [Running tests](#🔬-running-tests)
* [Built With](#🛠-built-with)
* [Author](#🎖-author)
* [License](#📝-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](https://chocolatey.org/install)
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](https://nodejs.org/)
* [ReactJs](https://reactjs.org/)
* [Yarn](https://yarnpkg.com/)
* [Express](https://expressjs.com/)
* [TypeScript](https://www.typescriptlang.org/)
## 🎖 Author
* **Geraldo Braz** - *Initial work* - [@geraldobraz](https://github.com/geraldobraz)
## 📝 License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details