https://github.com/justmert/dotly-frontend

https://github.com/justmert/dotly-frontend

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/justmert/dotly-frontend
• Owner: justmert
• License: mit
• Created: 2023-09-28T15:08:25.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-11T04:13:26.000Z (about 1 year ago)
• Last Synced: 2024-04-14T16:13:08.434Z (9 months ago)
• Language: TypeScript
• Size: 177 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Dotly Frontend

This is the frontend of the Dotly project. It is written in Next Js and uses Tailwind Css. It is deployed to Vercel. You can find the live version of the project [here](https://dotly.net/). 

If you want to run the frontend locally **with docker**, you need to follow this steps:

1. **Clone the project**

2. **Generate a docker build** 

    ```

    docker build -t dotly-frontend .

   ```

3. **Run the docker container with the following command**

   1. Auth token is bearer token and follow the steps in the [backend repo](https://github.com/justmert/dotly-backend) to get it, also api url is the url of the backend api that runs local, for production configurations are different

   2. Google analytics is optional, if you want to use it, you need to create a google analytics account and get the tracking id, then you can add it to the environment variable

   ```

   docker run -p 3000:3000 -e NEXT_PUBLIC_GOOGLE_ANALYTICS={GOOGLE_ANALYTICS_TOKEN} -e NEXT_PUBLIC_API_URL='http://localhost:8000' -e NEXT_PUBLIC_AUTH_TOKEN={AUTH_TOKEN_FROM_BACKEND} dotly-frontend

   ```

Now you can access the application from [http://localhost:3000](http://localhost:3000), but don't forget to start the backend docker container as well, you can find the instructions [here](https://github.com/justmert/dotly-backend)

---

If you want to run the frontend locally **without docker**, you need to follow this steps:

1. **Clone the project**

2. **Create .env.local file in the root directory with the following content:**

    Auth token is bearer token and follow the steps in the backend repo to get it, also api url is the url of the backend api that runs local, for production configurations are different

    Google analytics is optional, if you want to use it, you need to create a google analytics account and get the tracking id, then you can add it to the environment variable

    ```

    NEXT_PUBLIC_GOOGLE_ANALYTICS='G-XXXXXXXXXX'

    NEXT_PUBLIC_API_URL='http://localhost:8000'

    NEXT_PUBLIC_AUTH_TOKEN={BEARER_TOKEN}```

3. **Install Packages with following command**

    ```

    yarn install

    ```

4. **Run the application with following command**

    ```

    yarn dev

    ```