Template: README

A simple and straightforward README template.
View Demo • Report Bug • Request Feature

Table of Contents

1. About The Project
   • Technologies used
2. Development
   • Prerequisites
   • Make it your own
   • Install dependencies
   • Available Scripts
3. Usage
4. Base Dependencies
5. Folder Structure
6. License
7. Credits

About the project

Here we place the objective of the application as such. We can add additional information about the scope.

Technologies used

Development

Prerequisites

Here we'll list things you need to use the software and how to install them.

• Node js

Make it your own

To get a local copy, clone it using:

git clone https://github.com/castromaciel/readme-template.git

Or get it downloading

rm -rf .git && git init
git add .
git commit -m "Initial commit"

Install dependencies:

pnpm install
#or
yarn install
#or
npm install 

Available Scripts

In this project, you can run the following scripts:

Scripts	Description
pnpm build	Builds the app for production to the dist folder.
pnpm dev	Runs the app in the development mode.
pnpm test	Runs tests.

Usage

Use Template button

Click the Use this template button above the file list, then use the Owner drop-down menu, and select the account you want to own the repository. Creating a repository from a template has the following advantages:

A repository created from a template starts with a single commit. Commits to a repository created from a template do appear in your contribution graph. Creating a repository from a template starts a new project quickly.

Base Dependencies

• react create user interfaces from components.
• redux for stylesheets.
• jest and react-testing-library for testing.

Folder Structure

project-name/
├── node_modules             # Third party libraries
├── public                   # 
└── src                      # Root directory
|  ├── __tests__             # Test all functionalities
|  ├── components            # Common components
|  ├── helpers               # Common functions
|  ├── hooks                 # 
|  ├── pages                 # All pages of app
|  ├── routes                # Routes configuration
|  ├── services              # Requests to the server
|  ├── App.tsx               # 
|  ├── index.scss            # 
|  ├── main.tsx              # 
|  └── vite-env.d.ts         # 
├── .env.development         # 
├── .eslintignore            # 
├── .eslintrc.json           # Styleguide configuration
├── .gitignore               # Files ignored at publish into github
├── index.html               # 
├── LICENSE                  # License information
├── package.json             # 
├── README.md                # 
├── tsconfig.json            # 
├── tsconfig.node.json       # 
├── vite.config.js           # 

License

This project is licensed under the terms of the MIT license.

Credits

README template is built and maintained by Castro Maciel.

Badges used from Ileriayo • markdown-badges.