https://github.com/nomuq/restyjs-example

https://github.com/nomuq/restyjs-example

hacktoberfest hacktoberfest2020

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nomuq/restyjs-example
• Owner: nomuq
• License: mit
• Created: 2020-10-22T14:47:51.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-10-22T15:08:49.000Z (about 4 years ago)
• Last Synced: 2024-08-01T20:51:46.463Z (3 months ago)
• Topics: hacktoberfest, hacktoberfest2020
• Language: TypeScript
• Homepage:
• Size: 98.6 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# restyjs-example

## Folder Structure 

```

src

│   main.ts         # Application entry point

└───controllers     # route controllers for all the endpoints of the app

└───models          # TypeORM Entities

```

## Getting Started

### Step 1: Set up the Development Environment

You need to set up your development environment before you can do anything.

Install [Node.js and NPM](https://nodejs.org/en/download/)

- on OSX use [homebrew](http://brew.sh) `brew install node`

- on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`

### Install

- Install all dependencies with `yarn install`

### Running in dev mode

- Run `yarn start` 

- The server address will be displayed to you as `http://0.0.0.0:8080`

### Building the project and run it

- Run `yarn build` to generated all JavaScript files from the TypeScript sources.

- the builded app located in `dist`.