99 lines
2.8 KiB
Markdown
99 lines
2.8 KiB
Markdown
<div align="center" id="top">
|
|
<img src="./.github/app.gif" alt="Spiwork" />
|
|
|
|
 
|
|
|
|
<!-- <a href="https://spiwork.netlify.app">Demo</a> -->
|
|
</div>
|
|
|
|
<h1 align="center">Spiwork</h1>
|
|
|
|
<p align="center">
|
|
<img alt="Github top language" src="https://img.shields.io/github/languages/top/{{YOUR_GITHUB_USERNAME}}/spiwork?color=56BEB8">
|
|
|
|
<img alt="Github language count" src="https://img.shields.io/github/languages/count/{{YOUR_GITHUB_USERNAME}}/spiwork?color=56BEB8">
|
|
|
|
<img alt="Repository size" src="https://img.shields.io/github/repo-size/{{YOUR_GITHUB_USERNAME}}/spiwork?color=56BEB8">
|
|
|
|
<img alt="License" src="https://img.shields.io/github/license/{{YOUR_GITHUB_USERNAME}}/spiwork?color=56BEB8">
|
|
|
|
<!-- <img alt="Github issues" src="https://img.shields.io/github/issues/{{YOUR_GITHUB_USERNAME}}/spiwork?color=56BEB8" /> -->
|
|
|
|
<!-- <img alt="Github forks" src="https://img.shields.io/github/forks/{{YOUR_GITHUB_USERNAME}}/spiwork?color=56BEB8" /> -->
|
|
|
|
<!-- <img alt="Github stars" src="https://img.shields.io/github/stars/{{YOUR_GITHUB_USERNAME}}/spiwork?color=56BEB8" /> -->
|
|
</p>
|
|
|
|
<!-- Status -->
|
|
|
|
<!-- <h4 align="center">
|
|
🚧 Spiwork 🚀 Under construction... 🚧
|
|
</h4>
|
|
|
|
<hr> -->
|
|
|
|
<p align="center">
|
|
<a href="#dart-about">About</a>   |  
|
|
<a href="#sparkles-features">Features</a>   |  
|
|
<a href="#rocket-technologies">Technologies</a>   |  
|
|
<a href="#white_check_mark-requirements">Requirements</a>   |  
|
|
<a href="#checkered_flag-starting">Starting</a>   |  
|
|
<a href="#memo-license">License</a>   |  
|
|
<a href="https://github.com/{{YOUR_GITHUB_USERNAME}}" target="_blank">Author</a>
|
|
</p>
|
|
|
|
<br>
|
|
|
|
## :dart: About ##
|
|
|
|
Describe your project
|
|
|
|
## :sparkles: Features ##
|
|
|
|
:heavy_check_mark: Feature 1;\
|
|
:heavy_check_mark: Feature 2;\
|
|
:heavy_check_mark: Feature 3;
|
|
|
|
## :rocket: Technologies ##
|
|
|
|
The following tools were used in this project:
|
|
|
|
- [Expo](https://expo.io/)
|
|
- [Node.js](https://nodejs.org/en/)
|
|
- [React](https://pt-br.reactjs.org/)
|
|
- [React Native](https://reactnative.dev/)
|
|
- [TypeScript](https://www.typescriptlang.org/)
|
|
|
|
## :white_check_mark: Requirements ##
|
|
|
|
Before starting :checkered_flag:, you need to have [Git](https://git-scm.com) and [Node](https://nodejs.org/en/) installed.
|
|
|
|
## :checkered_flag: Starting ##
|
|
|
|
```bash
|
|
# Clone this project
|
|
$ git clone https://github.com/{{YOUR_GITHUB_USERNAME}}/spiwork
|
|
|
|
# Access
|
|
$ cd spiwork
|
|
|
|
# Install dependencies
|
|
$ yarn
|
|
|
|
# Run the project
|
|
$ yarn start
|
|
|
|
# The server will initialize in the <http://localhost:3000>
|
|
```
|
|
|
|
## :memo: License ##
|
|
|
|
This project is under license from MIT. For more details, see the [LICENSE](LICENSE.md) file.
|
|
|
|
|
|
Made with :heart: by <a href="https://github.com/{{YOUR_GITHUB_USERNAME}}" target="_blank">{{YOUR_NAME}}</a>
|
|
|
|
 
|
|
|
|
<a href="#top">Back to top</a>
|