Documentation
Here you should find everything you need from getting started with creating your Profile to more advanced topics. We welcome contributions, check out the LinkFree Repo and the documentation source on GitHub for more information.
Environment variables
Environment variables are needed in the .env file to allow the application to run correctly. .env.example file has an example template you can use to get started. However, you will need to follow these steps to get your GitHub OAuth environment variables.
| variable | example | required | description |
|---|---|---|---|
| LINKFREE_MONGO_CONNECTION_STRING | mongodb://localhost:27017/linkfree | true | Database connection string |
| NEXT_PUBLIC_GA_MEASUREMENT_ID | - | false | Google analytics id |
| NEXT_PUBLIC_BASE_URL | http://localhost:3000 | true | Hosting url |
| NODE_ENV | development | true | - |
| GITHUB_ID | abcedfghil12345 | true | GitHub OAuth ID |
| GITHUB_SECRET | a1b2c3e4f5e6 | true | GitHub OAuth Secret |
| NEXTAUTH_SECRET | afsfdsafadsf | true | Next Auth Secret, this can be any random characters |
GitHub OAuth
- Go to your profile `settings``
- Then
Developer settingsdown the bottom left - Click
New OAuth appand fill in the form details
| Form field | value |
|---|---|
| Application name | LinkFree local |
| Homepage URL | http://linkfree.eddiehub.io |
| Application description | Open Source alternative to LinkTree |
| Authorization callback URL | http://localhost:3000/api/auth/callback/github |
Then use the generated Client ID and Client Secret in the .env.
Full details on GitHub docs https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app