https://github.com/underdogbytes/my_readme_template
My default template of readme
https://github.com/underdogbytes/my_readme_template
Last synced: 4 months ago
JSON representation
My default template of readme
- Host: GitHub
- URL: https://github.com/underdogbytes/my_readme_template
- Owner: underdogbytes
- Created: 2020-12-13T13:50:36.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-07-17T16:45:14.000Z (almost 4 years ago)
- Last Synced: 2025-04-09T15:57:43.237Z (about 1 year ago)
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project name here
[](https://linkOfLanguageWebsite)
## Summary
[PREVIEW](#Preview) ♦ [ABOUT](#About) ♦ [GET STARTED](#Get-started) ♦ [PROJECT DEVELOPMENT STATUS](#Project-development-status) ♦ [THANKS](#Thanks) ♦
## 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:
# 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:
```sh
$ git clone https://github.com/wolfhaltz/example.git
$ cd example/
```
### Project Setup
```sh
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
```sh
Type the commands here (ex: npm run build)
```
### Run Headed Component Tests with [Testing Tools](https://tool-link)
```sh
Type the commands here (ex: npm run test:unit # or `npm run test:unit:ci` for headless testing)
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```
### Usage via Docker
To build the container run:
```sh
docker-compose build
```
...then run this:
```
docker-compose up
```
Open the website at http://localhost:3000 and its done! :D
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + 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!_
[PREVIEW](#Preview) ♦ [ABOUT](#About) ♦ [GET STARTED](#Get-started) ♦ [PROJECT DEVELOPMENT STATUS](#Project-development-status) ♦ [THANKS](#Thanks) ♦ [BACK TO TOP](#Project-name-here)