This repository contains the Vue.js client for the Atlas-Infra backend. Atlas is a URL shortener service with a microservices architecture, written in Go and TypeScript, and deployed on AWS.
Before running this frontend application, you must first deploy the Atlas-Infra project to your AWS account. Please follow the instructions provided in the README.md file of the atlas-infra repository.
After a successful deployment, you will need to obtain the following URLs from your AWS account:
- The HTTPS URL for the
atlas-api-gatewayAPI Gateway. - The WSS URL for the
atlas-websocket-apiAPI Gateway.
You can find these URLs in the AWS API Gateway service console. For the WebSocket API, ensure you are looking at the dev stage to get the wss:// URL.
Once you have the required URLs, you need to configure the local environment. This is done by creating a .env file. An example file is provided as .env.example.
The following commands assume a Unix-like operating system with a bash shell.
-
Copy the example environment file:
cp .env.example .env
-
Open the
.envfile in a text editor and fill in the required environment variables with the URLs you obtained in the previous step.# For example, using VS Code code .env
To run the project locally, follow these steps:
-
Install the project dependencies:
npm install
-
Start the local development server:
npm run dev
This will start the application on your local machine, and it should now be able to communicate with your deployed atlas-infra backend.