DavidProf / study-nestjs-demo

A nestjs project to practice

Game Assets Creator

A incredible demo project!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

A demo for projects.

A list of commonly used resources that I find helpful are listed in the Acknowledgements.

Built With

• NestJS

Getting Started

Follow this instructions on how to set up your project locally. To get a local copy up and running follow these simple steps.

Prerequisites

This is what need to use the software and how to install them (for ubuntu).

• Node

curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
sudo apt-get install -y nodejs

• yarn

with npm

npm install yarn@latest -g

or

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

sudo apt update && sudo apt install yarn

Installation

1. Clone the repo

git clone https://github.com/DavidProf/nestjs-demo.git

2. Go to the directory

cd nestjs-demo

3. Install packages

yarn

Usage

Run:

yarn star:dev

Access: http://localhost:3000

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat(some scope): Add some AmazingFeature'). Please use Conventional Commits
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

David Lima - @xarlyudo

Project Link: https://github.com/DavidProf/nestjs-demo

Acknowledgements

• NestJs Docs