Clear and easy meeting scheduling. Nothing else.

This is the GitHub repository for the app When.

To run/test this project locally, please follow the following steps

The app was built with .NET Core 3.1 as a backend which serves a React SPA as a Frontend. Therefore you need:

• .NET Core SDK (Installation Instructions)
• Node.js (Installation Instructions)
• (optional) PostgreSQL (Installation Instructions)

For macOS/Linux, you might as well refer to Homebrew/your respective package manager to install these dependencies.

After you have installed all the necessary dependencies and cloned the project with git clone https://github.com/Paccos/When.git, you can run it using one of the following methods:

Simply start Visual Studio, open the When.sln file in the Project root and click "Run".

1. Navigate into the When project folder which is in the Project root

   cd $PATH_TO_REPO/When

2. Run the project with the dotnet runtime

   dotnet run

Both methods should install the necessary project dependencies (even the npm packages from the React app) on the first build and run the server. You can then access the React app with a browser of your choice using the URL:

https://localhost:5001

When uses an In-Memory-Database when the environment variable $DATABASE_URL is not set. This allows for quick prototyping without having to worry about installing/maintaining a local database only for testing purposes.

However, if you do want to provide a local Postgres database in order to test some database functions, you can provide such a URL to your local database as follows:

1. Construct URL from your database credentials and set environment variable:

   export DATABASE_URL="postgres://<username>:<password>@localhost:5432/<database-name>"

   Assuming, that your Postgres server runs on port 5432 on your machine.

   The app will build a connection string from this URL and connect to your local database.

2. Run migrations to the local database:

   dotnet ef database update

   This will make EntityFramework create the necessary tables and relations in your local database. ($DATABASE_URL has to be set here as well!)

After that, you can run the app using the steps above and When will use your database as a persistent storage across restarts so that your data doesn't get lost.

0. (Preferably) Create an issue in the Issues tab and assign it to yourself so that it is clear, what is currently being worked on.
1. Fork this repo
2. Make your desired changes
3. Make a Pull Request to this repo's develop branch
4. Get reviewed
5. Profit 😀

Found a bug? Have some ideas? Need help?

Feel free to write an issue on the Issues tab!

You are also free to fix the issue yourself and make a Pull Request, as stated above, with your changes if you have a solution in mind.