https://github.com/cedric921/linkfarm

https://github.com/cedric921/linkfarm

Last synced: about 4 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/cedric921/linkfarm
• Owner: Cedric921
• License: mit
• Created: 2024-01-24T13:37:12.000Z (10 months ago)
• Default Branch: develop
• Last Pushed: 2024-02-12T10:09:16.000Z (9 months ago)
• Last Synced: 2024-02-13T11:31:40.031Z (9 months ago)
• Language: TypeScript
• Size: 36 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# LinkFarm Website

This is a [Next.js](https://nextjs.org) based website

The project's structure is as follows:

- An Adonis.js Backend

- A Next.js frontend that uses React for rendering components, custom hooks for API requests to API to fetch data, and responsive design.

## Content

- A dynamic frontend built with [Next.js](https://nextjs.org) in `/packages/web` folder

## Quick start

1. Clone this repository

2. `yarn install` in the project root folder on local to install npm packages

3. `yarn start` to start the studio and frontend locally

   - Your API should be running on ...

   - Your frontend should be running on [http://localhost:3000](http://localhost:3000)

4. Lint the code with:

```bash

# Linting scss files run

   yarn lint-fix:scss

# Linting ts and tsx files

   yarn lint-fix

# Format using prettier

   yarn prettier

# Before any commit run

   yarn precommit

```