From 7777111f97a7f4d33d608203debf85021c843727 Mon Sep 17 00:00:00 2001 From: Ben Borla Date: Wed, 28 Aug 2024 23:02:00 +0800 Subject: [PATCH] updated readme --- README.md | 44 +++++++++++++++++--------------------------- 1 file changed, 17 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 36ac9ed..1438e2a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ + # Rust Microservice Starter Kit
@@ -20,16 +21,14 @@ - [About](#about) - [Getting Started](#getting_started) - [Deployment](#deployment) -- [Usage](#usage) - [Built Using](#built_using) -- [TODO](../TODO.md) -- [Contributing](../CONTRIBUTING.md) - [Authors](#authors) -- [Acknowledgments](#acknowledgement) ## 🧐 About This Rust Microservice Starter Kit is designed to provide a solid foundation for building high-performance, type-safe, and memory-safe microservices. It leverages the power of Rust along with modern frameworks and tools to ensure robust and efficient API development. +**Visit Demo: https://ensign-api.fly.dev/** + ### Key Features: - **Rust**: A language empowering everyone to build reliable and efficient software. - **Axum**: A modular web framework that's built with Tokio, Tower, and Hyper. @@ -77,18 +76,18 @@ This Rust Microservice Starter Kit is designed to provide a solid foundation for ``` -These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system. +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. ### Prerequisites What things you need to install the software and how to install them. -``` + - Rust (latest stable version) -- PostgreSQL -- Docker (optional, for containerization) -- WIP -``` +- [SeaORM CLI](https://www.sea-ql.org/SeaORM/docs/generate-entity/sea-orm-cli) +- [Neon PostgreSQL](https://neon.tech) + - Or if you want to hose your PostgreSQL, you may install PostgreSQL in your local machine + ### Installing @@ -102,7 +101,7 @@ A step by step series of examples that tell you how to get a development env run 2. Install dependencies ``` - cargo build + cargo build; cd migration; cargo build ``` 3. Set up the database @@ -111,29 +110,26 @@ A step by step series of examples that tell you how to get a development env run cp .env.dist .env # Run migrations - cargo run --bin migrate + cd migration + cargo run -- up ``` -4. Run the application +4. Go back to the project, then run the application ``` cargo run ``` -The server should now be running on `http://localhost:8080`. +The server should now be running on `http://localhost:3380`. ## 🔧 Running the tests -Explain how to run the automated tests for this system. - +You may find the tests files in `./tests` +Note: There's a sample Unit Test available, you may run it using ``` cargo test ``` -## 🎈 Usage --- TODO -- - ## 🚀 Deployment --- TODO -- - +You may deploy this using [FlyIO](https://fly.io/). ## ⛏️ Built Using - [Rust](https://www.rust-lang.org/) - Programming Language - [Axum](https://github.com/tokio-rs/axum) - Web Framework @@ -142,12 +138,6 @@ cargo test - [SeaORM CLI](https://www.sea-ql.org/SeaORM/docs/generate-entity/sea-orm-cli/) - Official SeaORM CLI tool - [Postgres](https://www.postgresql.org/) - Database - [Neon](https://neon.tech/) - Serverless Postgres for modern developers -- [Docker](https://www.docker.com/) - Containerization (Soon) ## ✍️ Authors - [@benborla](https://github.com/benborla) - Idea & Initial work - -See also the list of [contributors](https://github.com/benborla/rust-microservice-starter-kit/contributors) who participated in this project. - -## 🎉 Acknowledgements -- WIP