all-in-one

Write something nice here

About • Technologies • How to run • Contributions • License • Author

💡 About the project

Describe your project here
You can write anything your heart desires. Just put real information, be nice and keep your reader interested

RAN OUT OF IDEAS? grab some examples:

. Explains where did the idea come from
. Especify the purpose of the application
. You can always place a printscreen or a GIF (never underestimate an image)

🚀 Technologies

Sure thing, you used something to build your application. Tell us :)
(just a reminder.. it could be a good idea to put the documentation as a link)

. TypeScript

. ReactJS

. Node.js

. React Native

💻 How to run

Here you will explain how to inicialize your application
Yeah, I know, I don't like this part either.. So, I'll be nice an give you an example of how I usually do this.

FIRST OF ALL

• You will need to have node.js installed in you machine;
• Also, it's very important to have a package manager, you can use yarn or npm;

CLONE THIS REPOSITORY

$ git clone https://github.com/iaraoliveira/my-repository.git

INSTALLING THE DEPENDENCIES

# run this if you're using yarn
$ yarn

# or this if you're using npm
$ npm install

RUN THE APPLICATION

# go to server directory
$ cd server

# run backend
$ yarn start

# go to web directory
$ cd web

# run web frontend
$ yarn start

# go to mobile directory
$ cd mobile

# run mobile frontend
$ npm start

🤝 How to contribute

Let other devs know that they can contribute for your project as well

FORK THIS REPOSITORY

# if you're using GitHub CLI, run this command
# but using the website interface is also an option

$ gh repo fork iaraoliveira/NOME_DO_REPO

STEP BY STEP

# clone the repo you just forked
$ git clone your-fork-url && cd NOME_DO_REPO

# create a branch
$ git checkout -b my-feature

# add and commit your modifications
$ git add .
$ git commit -m 'feature: minha contribuição'

# send your brand new code to the created branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch.

📔 License

This part is to especify if your project is under a license.
Usually, I use the MIT, but you can pick the one that better relates with what your doing.

There is a tutorial of how to add a lincense to your repository
And if you don't know which license to choose, read more about it here, clica aí no link.

This project is under the MIT license, you can read more about it in LICENSE

With 🤍 by iara
Let's talk