To run the dev server all you need to do is to:
- Define your .env file
- Contentful api key (CONTENTFUL_API_TOKEN)
- Contentful space (CONTENTFUL_SPACE)
- Github API key (GITHUB_API_TOKEN)
- Github username (GITHUB_USERNAME)
- LinkedIn id (LINKED_IN_USER_ID)
- Email address (EMAIL)
- Run
npm install - Run
npm run codegen - Run the development server with
npm run start
This will open a nextjs development server. Now all you need to do is to start developing.
The simplest way to run this project is with docker using the publicly available images built by the CI.
-
Run
docker pull <image:tag>- The image name and tag can be found in the packages section of the repository
-
Create a .env file where you define the following:
- Contentful api key (CONTENTFUL_API_TOKEN)
- Contentful space (CONTENTFUL_SPACE)
- Github API key (GITHUB_API_TOKEN)
- Github username (GITHUB_USERNAME)
- LinkedIn id (LINKED_IN_USER_ID)
- Email address (EMAIL)
-
Create a Contentful account, this can be done for free using your github account.
-
Add the appropriate content model into your contentful space
- The content model in contentful has two text fields: "title" and "description", and a long markdown text field "postContent"
-
Run the docker container, mapping port 3000 inside the container to the desired port your host machine
-
Profit