https://github.com/brbertholini/api-airball
https://github.com/brbertholini/api-airball
docker nodejs typescript
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/brbertholini/api-airball
- Owner: brbertholini
- Created: 2024-09-12T13:24:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T01:32:34.000Z (over 1 year ago)
- Last Synced: 2024-12-30T00:24:38.747Z (over 1 year ago)
- Topics: docker, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 164 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Table of Contents
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://example.com)
Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`
### Built With
* [![Typescript][Typescript]][Ts-url]
* [![Node][Node.js]][Nodejs-url]
* [![Express][Express.js]][Express-url]
* [![Docker][Docker]][Docker-url]
* [![MySQL][MySQL]][MySQL-url]
* [![Prisma][Prisma]][Prisma-url]
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* npm
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/brbertholini/api-airball.git
```
2. Install NPM packages
```sh
npm install
```
3. Enter your DATABASE_URL in `.env`
```.env
DATABASE_URL=YOUR_DATABASE_URL
JWT_SECRET=TEST
```
5. Run the migrations
```sh
npx prisma migrate dev
```
6. Start the server
```sh
npm run dev
```
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
_For more examples, please refer to the [Documentation](https://example.com)_
## Roadmap
- [ ] Feature 1
- [ ] Feature 2
- [ ] Feature 3
- [ ] Nested Feature
See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### Top contributors:
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)
## Acknowledgments
* []()
* []()
* []()
[contributors-shield]: https://img.shields.io/github/contributors/brbertholini/api-airball.svg?style=for-the-badge
[contributors-url]: https://github.com/brbertholini/api-airball/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/brbertholini/api-airball.svg?style=for-the-badge
[forks-url]: https://github.com/brbertholini/api-airball/network/members
[stars-shield]: https://img.shields.io/github/stars/brbertholini/api-airball.svg?style=for-the-badge
[stars-url]: https://github.com/brbertholini/api-airball/stargazers
[issues-shield]: https://img.shields.io/github/issues/brbertholini/api-airball.svg?style=for-the-badge
[issues-url]: https://github.com/brbertholini/api-airball/issues
[license-shield]: https://img.shields.io/github/license/brbertholini/api-airball.svg?style=for-the-badge
[license-url]: https://github.com/brbertholini/api-airball/blob/master/LICENSE.txt
[product-screenshot]: images/screenshot.png
[Node.js]: https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white
[Nodejs-url]: https://nodejs.org/
[Typescript]: https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white
[Ts-url]: https://www.typescriptlang.org/
[Docker]: https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white
[Docker-url]: https://www.docker.com/
[Prisma]: https://img.shields.io/badge/Prisma-3982CE?style=for-the-badge&logo=Prisma&logoColor=white
[Prisma-url]: https://www.prisma.io/
[Express.js]: https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB
[Express-url]: https://expressjs.com/pt-br/
[MySQL]: https://img.shields.io/badge/mysql-4479A1.svg?style=for-the-badge&logo=mysql&logoColor=white
[MySQL-url]: https://www.mysql.com/