Visintus

A web application to manage visit programs.

Running it locally (development)

You can run the project locally by following the setup guide below.

Setup MongoDB

This project uses MongoDB to store the data. You may refer to the official documentation on how to setup the database on your device.

Setup the backend

• Ensure that you have MongoDB running on your system and navigate to the backend folder.

• Create the databases

  • By default, the backend service uses the following databases:
    • Production: visintus
    • Development: visintus_development
    • Test: visintus_test
  • You may need to create those databases first before running the backend service. Besides, you can also change the databases name in the config file(s).

• Create a user to access the database(s).

  • Please ensure that you grant the user read/write access to those databases.
  • By default, the backend service will try to use a user with username visintus and password visintus.
  • To configure your own database access, you can set your own DB_URL in the environment file that will be explained in the next point.

• Configure your environment variables.

  • If you don't have the environment file yet, go to your favorite code editor and create a .env file. To do so, copy from the .env.example file and specify the required values based on your own configuration.

• Run yarn install to install all dependencies.

• Run yarn run dev:db:seed to seed the database. When you get [OK], just click CTRL+C to stop.

Running the backend

• Ensure that you have MongoDB running on your background service and you have completed the basic setup.
• Run yarn run dev on the back-end folder and make sure you get db connection [OK]
• To test if all you've done correctly, visit https://localhost:3000 and you should see "Welcome to Visintus API"

Setup the webclient

• Navigate to the webclient folder.
• Run yarn install to install all dependencies.

Running the webclient

• Ensure that you have the backend service running.
• Run yarn start
• Visit https://localhost:3001 to view the web.

Setup MailDev

Some of the features in Visintus involve sending email(s) to user. In the development mode, it will try to access a proxy at localhost:1025 to "send" the email.

In this project, we use MailDev to configure the proxy and display the emails. To setup MailDev, you can just follow the instructions below:

• Install MailDev by running: yarn install -g maildev.
• Open a separate terminal and run maildev.
• Open https://localhost:1080 to open maildev in the browser.

Creating your superadmin account

• Ensure that you have the backend, webclient, and maildev running.
• Go to https://localhost:3001/login from your browser's address bar and click "Do not have an account?".
• Fill up credentials for your superadmin account. Click signup.
• Open the maildev tab, and an email should have been sent to you.
• Click on the link and it will redirect you to verify your email.
• Open mongo console in terminal, login to "visintus_development" database using your db account.
• Make sure you have the user in the db by running db.users.find({}).pretty() in the mongo console.
• Update your superadmin account to have role: "superadmin".
• Now, go to https://localhost:3001/login and login using your superadmin account.
• If all is well, go to https://localhost:3001/admin and you should see "User" on the left pane of Admin page, where you can change authorization rules for other users.

Accessing admin page

• Make sure you have made a superadmin user to access all admin functionalities
• Go to https://localhost:3001/login from your browser's address bar and login using your superadmin credentials.
• Then either go to https://localhost:3001/admin or account > admin to go to admin page.