Skip to content

underdogbytes/my_readme_template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 

Repository files navigation

Project name here

Language Version GitHub Repo Size

banner

Summary

PREVIEWABOUTGET STARTEDPROJECT DEVELOPMENT STATUSTHANKS

Preview

Figma: Coming soon

Behance: Coming soon

About

This is an application for ??????, created using ?????? that shows ?????????????. The main rules are:

  • Example
  • Example
  • Example
  • Example

For more information about the it, check:

example

Get started

Before start

You must have the down below to run the project locally:

Locally project setup

To clone the project, navigate to its folder and to install required packages, run the following commands on the command prompt:

$ git clone https://github.com/wolfhaltz/example.git
$ cd example/

Project Setup

TYpe the commands heres (ex: npm install)

Compiles and hot-reloads for development

Type the commands here (ex: npm run dev)

Compile and Minify for Production

Type the commands here (ex: npm run build)

Run Headed Component Tests with Testing Tools

Type the commands here (ex: npm run test:unit # or `npm run test:unit:ci` for headless testing)

Lint with ESLint

npm run lint

Usage via Docker

To build the container run:

docker-compose build 

...then run this:

docker-compose up

Open the website at http://localhost:3000 and its done! :D

Recommended IDE Setup

VSCode + whatever

Project development status

Last update: XX/XX/2021

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin pharetra molestie finibus. Donec lacinia quam at est lobortis tempus. Proin ac ipsum vel orci aliquam consectetur.

To-do:

  • Example
  • Example

Thanks

Lorem ipsum dolor sit amet

Thank you for your support!

... And stay awesome Gothan!

PREVIEWABOUTGET STARTEDPROJECT DEVELOPMENT STATUSTHANKSBACK TO TOP

About

My default template of readme

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors