Delavalom/fulltimeforce

Take-Home Test

README

Getting Started

To get a local copy up and running, please follow these simple steps.

Prerequisites

Here is what you need to be able this project.

• Node.js (Version: >=18.x)
• Pnpm

Installation

Setup

1. Clone the GitHub repository.

   git clone https://github.com/Delavalom/fulltimeforce.git
   

2. Install packages with pnpm

   pnpm i
   

3. Set up your .env file in both the two apps: frontend and server.

Server

• Duplicate .env.example to .env.
• Sign up for a free GitHub account, create a GitHub personal access token, and store it in the .env file under API_KEY.
• Optionally, you can specify a port number under PORT in the .env file.

Frontend

• Duplicate .env.example to .env.
• Create a GitHub repository and store the URL in the .env file under VITE_REPO_URL.
• Start your server and copy the URL, which could be localhost if you are local, and store it in the .env file under VITE_PUBLIC_NESTJS_SERVER.

Quick start with pnpm dev

This application uses pnpm workspace, and the scripts are set up to run both applications simultaneously. Also, when you want to deploy them, they have their own individual scripts in the root package.json.

Example Application

Explore the example application: Application Example

Deployment

You can easily deploy your own to Railway following this guide:

Server

1. First, go to Railway and start a new project:

1. Now select the repo where you store this code:

1. Add the environment variables mentioned above:

1. Update the Service Name, watch path, build command, and start command to avoid confusion:

Frontend

1. Now, repeat the same process for the frontend by adding a new service.

Contributing

Here's how you can contribute:

• Open an issue if you find a bug.
• Make a pull request for new features, improvements, or bug fixes.

License

This project is licensed under the MIT license.