Redlink2Web is a web application built with Nuxt.js. It features an image gallery and games like Simon and Tic Tac Toe. The application also interacts with a database, possibly FaunaDB.
To set up the project locally for the first time, follow these steps:
- Clone the repository:
git clone https://github.com/redlink2/redlink2web.git
- Navigate to the project directory:
cd redlink2web
- Install the dependencies:
yarn install
To start the development server, run yarn dev
.
To build and run the project, follow these steps:
- Build the application with
yarn build
. - If you have previously created a 'redlink2' process with pm2, delete it with
pm2 delete redlink2
. This step is optional and only needed if a 'redlink2' process already exists. - Start a new 'redlink2' process with
pm2 start --watch --name 'redlink2' ecosystem.config.js
. This process is automated with a GitHub Actions workflow. For more details, see the workflow file.
Contributions are welcome! Here's how you can contribute:
- Fork the repository.
- Create a new branch for your changes.
- Make your changes in your branch.
- Submit a pull request.
Before contributing, please read the contributing guide.