https://github.com/imshawan/refineit
https://github.com/imshawan/refineit
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/imshawan/refineit
- Owner: imshawan
- License: mit
- Created: 2024-08-13T19:00:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-29T02:22:14.000Z (9 months ago)
- Last Synced: 2025-06-13T11:43:04.243Z (7 months ago)
- Language: TypeScript
- Size: 1.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RefineIt
## Getting Started
1. **Clone the repository:**
```bash
git clone https://github.com/imshawan/RefineIt.git
cd RefineIt
```
2. **Copy the example environment file and update the values:**
```bash
cp .env.example .env
```
3. **Install dependencies:**
```bash
go mod tidy
```
4. **Run the application:**
```bash
go run main.go
```
## Environment Variables
Update the `.env` file with your specific configurations before starting the app
## Major Dependencies
- [Gin Web Framework](https://github.com/gin-gonic/gin) for creating the REST APIs
- [Postgres Go Driver](https://pkg.go.dev/github.com/lib/pq) for communicating with Sql Database
- [JWT Go](https://github.com/golang-jwt/jwt/) for authentication purposes
- [Viper](github.com/spf13/viper) for config management throughout the application
## Development
This project uses [Air](https://github.com/air-verse/air) for live reloading during development. To use it:
1. **Install Air:**
```bash
go install github.com/air-verse/air@latest
```
2. **Run the project using Air:**
```bash
air
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b improvement/AmazingImprovements`)
3. Commit your changes (`git commit -m 'Added some amazing improvements'`)
4. Push to the branch (`git push origin improvement/AmazingImprovements`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.