Actix Web - API Template

In Development

Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Contributing
4. License

About The Project

A simple Actix API Template to reuse in my future Actix porjects

Built With

• Actix
• Diesel
• Postgres

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/ccr5/api-actix-diesel-template.git

2. Install libpq

   sudo apt-get install libpq-dev

3. Run Docker Compose

   docker compose up -d

4. Run Project

   cargo run

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

License

Distributed under the MIT License. See LICENSE for more information.