ResidentMail

Provide a web form to send email.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To start working on this project you need to download and install the following components:

• .NET Core SDK (Software Development Kit)
• Visual Studio Code (Code editor)
• git (Distributed version control system)
• Download the files from Github.

Download and install

Install .NET Core SDK

1. Get the latest version of .NET Core on the dotnet web site.

2. When the installation is complete, open a new command prompt and run the following command:

\> dotnet --info

The command should print out information about the version, the runtime environment and a list of .NET Core SDKs installed.

.NET Core SDK (reflecting any global.json): Version: 3.1.300 Commit: b2475c1295

Runtime Environment: OS Name: Windows OS Version: 10.0.18363 OS Platform: Windows RID: win10-x64 Base Path: C:\Program Files\dotnet\sdk\3.1.300\

Install Visual Studio Code

1. Download the latest version of Visual Studio Code installer for Windows.

2. Once it is downloaded, run the installer (VSCodeUserSetup-{version}.exe).

3. By default, Visual Studio Code is installed under C:\users{username \AppData\Local\Programs\Microsoft VS Code.

Install Git

This procedure assumes you want to use a distributed version control system to contribute to this project. Git is not mandatory to develop or to simply run an ASP.NET Core web application. In this case, simply download the repository from Github using the ZIP file option.

1. Download the latest version of the git installer for Windows.

2. Run the installer (Git-{version}-64-bit.exe).

3. The installer allow you to select the default text editor for Git. Accept the default if you prefer to change this later.

4. When the installation is complete, open Git Bash and run the following command:

\> git --version

5. The command should print out information about the version.

git version 2.22.0.windows.1

Download the project from Github

This procedure assumes you have already created a repository on GitHub, or have an existing repository owned by someone else you'd like to contribute to.

1. Create the directory on your local machine where you want this project to reside.

\> mkdir C:\Project\ResidentMail
\> cd .\Project\ResidentMail

2. Open your browser and navigate to Github. Access the main page of the repository.

3. Next, get a copy of the project in a ZIP file or using git commands. Follow procedures below.

Download the ZIP file

1. Under the repository name, click Clone or download.

2. Select Download ZIP.

3. Extract the ZIP file in your project folder (ex C:\Project\ResidentMail).

Clone using git

1. Under the repository name, click Clone or download.

2. In the Clone with HTTPs section, copy the clone URL for the repository.

3. Open Git Bash.

4. Navigate to the project directory where you want the cloned directory to be made (C:\Project\ResidentMail).

5. Type git clone, and then paste the URL you copied in Step 2.

\>git clone https://github.com/residentsystem/ResidentMail

5. Press Enter. Your local clone will be created.

Verify installation

1. Change the current working directory to the project folder and open the project using Visual Studio Code.

\> cd C:\Project\ResidentMail\ResidentMail
\> code .

2. Using VS Code, select Terminal -> New Terminal. Inside the terminal, run the application.

3. Open file MailSettings.json and add configuration options. You'll need access to an email automation service that will offer a complete service for sending, receiving and tracking email sent through a website and application.

{ "MailSettings": { "Name": "name", "Address": "[email protected]", "Host": "smtp.domain.org", "Port": "587", "Username": "[email protected]", "Password": "password"
} }

Deployment

When you are done with development and testing and ready to make use of the application, you will need to publish it first. The dotnet publish command will compile the code and then copy the files required to run the application into a publish folder.

1. Create a folder where you wish to have the published files located. Change the current working directory to the project folder.

\> mkdir C:\Publish\ResidentMail
\> cd C:\Project\ResidentMail\ResidentMail

2. Run this command to Publish the application.

\> dotnet publish -o "C:\Publish\ResidentMail" -c Release

4. Go to the publish folder and run the project exe.

\> cd C:\Publish\ResidentMail
\> dotnet .\ResidentMail.exe

5. The command should print information about the hosting environment, url and port listening but this time the hosting environment will indicate "Production".

Built With

• Visual Studio Code - Code editor
• .NET Core SDK 3.1.300 - Open-source development platform

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Eric Lacroix - Initial work

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.