Getting Started

Learn how to setup your development environment to contribute to the FEDS platform.

1

Clone the Repository

Use the following command to pull the GitHub repository:

git clone https://github.com/VirajShah21/Feds

If this command fails, you do not have permission to access the repository. You must request access prior to cloning.

2

Setup a MySQL Docker Container

Use this command to create a MySQL Docker container:

docker run MYSQL_ROOT_PASSWORD=rootpassword -p 3306:3306 -d mysql

The command retrieves the Docker image, establishes port forwarding, and assigns a password to the root user.

Next, you must create the FEDS schema in the database. Do not add any tables or routines to the schema; Entity Framework will handle this on the first application launch.

3

Setup the Environment Variables

Add a .env file to the FEDS project root (not the solution root). Add the following content:

.env

export FEDS_EMAIL_ADDRESS="[email protected]"
export FEDS_EMAIL_PASSWORD="platform.email.password"
export FEDS_SMTP_SERVER="smtp.gmail.com"
export PLATFORM_VERSION="vX.Y.Z"

Replace the email address and password with the default details. Make sure not to add this to GIT and not to publish this file anywhere.

If you accidentally commit this file, reset the HEAD. Do not push that commit anywhere. If you accidentally push the commit, you must either revoke the GMAIL application token or reset your email password.