Skip to content

πŸ—žοΈ Readme template open source to dev community.

License

Notifications You must be signed in to change notification settings

rafaelfachinelli/readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

80 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

English Portuguese

PROJECT NAME

Repository Size GitHub last commit Developed by NAME Project License

Preview β€’ About β€’ Tasks β€’ Run β€’ Technologies β€’ Contributors β€’ Author β€’ License


πŸ‘οΈβ€πŸ—¨οΈ Preview

πŸ–₯️ Computer

Desktop Ultra Wide
Desktop Ultra Wide

πŸ“± Responsive

Tablet Mobile
Tablet Mobile

ℹ️ About

Description about this project.


πŸ“ Tasks

Click to View
State Task
βœ”οΈ Describe your task finished.
❌ Describe your task unfinished.

▢️ Run

To run the project you need to clone or download this repository, have the Node Package Manager (NPM) or the YARN Package Manager installed (YARN).

🌐 Web

Open the command prompt in the project directory, open the example/ folder and execute the following commands:

with npm
# Install dependencies
$ npm install

# Start development server
$ npm start
with yarn
# Install dependencies
$ yarn

# Start development server
$ yarn start

⚠️ The development server will start on port:PORT - Access http://localhost:PORT

πŸ“± Mobile

Open the command prompt in the project directory, open the example/ folder and execute the following commands:

with npm
# Install dependencies
$ npm install

# Start development server
$ npm start
with yarn
# Install dependencies
$ yarn

# Start development server
$ yarn start

⚠️ The development server will start on port:PORT - Access http://localhost:PORT

πŸ—„οΈ Server

Open the command prompt in the project directory, open the example/ folder and execute the following commands:

with npm
# Install dependencies
$ npm install

# Start development server
$ npm start
with yarn
# Install dependencies
$ yarn

# Start development server
$ yarn start
πŸ’« API Routes
[POST] Create OBJECT /api/create/OBJECT
[PUT] Update OBJECT /api/update/OBJECT/:id
[GET] Get OBJECT /api/view/OBJECT/:id
[GET] Get All OBJECTS /api/view/OBJECTS
[DEL] Delete OBJECT /api/delete/OBJECT/:id
[DEL] Delete All OBJECTS /api/delete/OBJECTS

⚠️ The development server will start on port:PORT - Access http://localhost:PORT


πŸ› οΈ Technologies

The following tools is used to build this project:

🌐 Web πŸ“± Mobile πŸ—„οΈ Server
Example Example Example

πŸ’ͺ Contributors

Thanks to all these wonderful people:


πŸ‘¦ Author

Profile Photo AUTHOR NAME
AUTHOR NAME

Developed with ❀️ by AUTHOR NAME πŸ‘‹πŸ½ Contact me!

Linkedin Badge Github Badge Outlook Badge


βš–οΈ License

Copyright Β© 2021 NAME.
This project is licensed by MIT.

About

πŸ—žοΈ Readme template open source to dev community.

Topics

Resources

License

Stars

Watchers

Forks