GoalAim后端

目录

• 介绍
• 安装
  • 数据库
  • 服务器
• 单元测试
• 文档
  • Swagger

介绍

这里是Rust服务器的仓库。
应用程序将调用服务器以获取信息。

安装

本地数据库

您需要使用Docker设置本地PostgreSQL数据库。

# Install diesel
cargo install diesel_cli --no-default-features --features postgres

# creation du docker:
sudo docker run --name goalaim_db -d -p 5432:5432 -e POSTGRES_PASSWORD=admin postgres

# CMD for the end
# Connect yourself to the docker :
psql --host=0.0.0.0 -U postgres

# Always restart the docker :
sudo docker update --restart always goalaim_db

# In the docker :
CREATE DATABASE goalaim_db;
CREATE DATABASE test_db;

# In the .env at the root of the project
DATABASE_TEST_URL=postgres://postgres:[email protected]/test_db
DATABASE_URL=postgres://postgres:[email protected]/goalaim_db
PORT=8080
JWT_SECRET="celui qui lit ça est gay"

对于Diesel，在您的.bashrc或.zshrc中设置此选项，然后重启终端。

# relace user by the real name
export PATH="$PATH:/home/user/.cargo/bin"

在docker psql中创建表

diesel migration run

检查表是否已创建

# Connection
psql --host=0.0.0.0 -U postgres

# Connect yourself to the db
\connect goalaim_db

# Check if table exist
SELECT * FROM users;

启动服务器

要启动服务器，请运行

cargo build

# or directly
cargo run

单元测试

运行单元测试

cargo test

文档

获取代码的文档

cargo doc

现在您必须转到 ${ACTUAL_PATH}/target/doc/goalaim/ 并在浏览器中打开index.html。

Swagger

您可以在Swagger中找到我们的API路由的Swagger。

您可以在vscode中使用Swagger Preview扩展预览我们的Swagger。

贡献者

您可以通过以下方式联系我们：

• Noeme Suisse : [email protected]
• Victor Massonnat [email protected]

Noeme Suisse

Victor Massonnat