Skip to content

VagnerNerves/default-readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 

Repository files navigation

Project Title Logo

Project Title

🔗 https://URLThisProject.com 🔗

Write here what the project is about. 🚧 Project under construction 🚧

🧭 Table of contents

🎥 Implementation Video

In the GitHub edit, drag the video that it already puts on github itself.

🎨 Layout

Layout developed by Name

Layout in Figma

👏 Learning and more Implementations

Describe what you learned and implemented in the project.

💡 Technologies Used

📂 Folder Structure

app
.
├── __tests__
├── android                     # Native android files
├── ios                         # Native ios files
├── src                         # Source files
│   ├── @types                  # Contains all global definitions of types and interfaces
│   ├── assets                  # Contains Js bundles assets. e.g: icons, splash, images etc...
│   ├── components              # Contains all global react components
│   ├── context                 # All contexts
│   ├── constants               # Constants files
│   ├── hooks                   # Cstomized hooks
│   ├── navigation
│   ├── screens
│   ├── services                # Contains external and api services
│   ├── App                     # Aplication entry
.
.
├── index                       # Bundle entry
.
.
└── README.md

🚀 Running the Project

Back-end

Clone the project

  git clone https://link-para-o-projeto

Enter the project directory

  cd my-project

Install with dependencies

  npm install

Start the server

  npm run start

Front-end Web

Clone the project

  git clone https://link-para-o-projeto

Enter the project directory

  cd my-project

Install with dependencies

  npm install

Start the server

  npm run start

Mobile

Clone the project

  git clone https://link-para-o-projeto

Enter the project directory

  cd my-project

Install with dependencies

  npm install

Start the server

  npx expo start
  • IOS:
  npx pod-install && npx react-native run-ios
  • Android:
  npx react-native run-android

📝 Routes

Run in Postman Run in Insomnia

🌎 License

This project is under the MIT license. See the LICENSE file for more details.

✒ Author

Author Vagner Nerves

Vagner Nerves

Made with love and hate 😅, get in touch!

Linkedin Badge Gmail Badge GitHub Badge

About

Created standard readme for use in projects.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published