Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcolink/contentful-remix-starter-blog
Remix starter for a Contentful blog (template) project
https://github.com/marcolink/contentful-remix-starter-blog
blog contentful remix starter templates typescript
Last synced: 3 months ago
JSON representation
Remix starter for a Contentful blog (template) project
- Host: GitHub
- URL: https://github.com/marcolink/contentful-remix-starter-blog
- Owner: marcolink
- Created: 2022-01-25T06:14:04.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-27T08:29:23.000Z (4 months ago)
- Last Synced: 2024-02-28T09:56:51.461Z (4 months ago)
- Topics: blog, contentful, remix, starter, templates, typescript
- Language: TypeScript
- Homepage: https://contentful-remix-starter-blog.vercel.app/
- Size: 3.52 MB
- Stars: 18
- Watchers: 1
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Lists
- awesome-stars - marcolink/contentful-remix-starter-blog - Remix starter for a Contentful blog (template) project (TypeScript)
README
# Contentful Remix Starter Blog
 
Create a [Remix](https://remix.run/) blog powered by [Contentful](https://www.contentful.com). Based on the [contentful gatsby starter](https://github.com/contentful/starter-gatsby-blog) blog repo.
## Getting started
### Get the source code and install dependencies
```shell
$ git clone [email protected]:marcolink/contentful-remix-starter-blog.git
$ npm install
```
Or hit the `Use this template` button on the repo page.
### Create contentful space
Create contentful account or use your existing account to create a space.
Now create a delivery and management token.
### Create environment variables
We now need to set up some env variables:
> I personally like to use `direnv` to manage my env variables. [go check it out!](https://direnv.net/)
```
# your space id
export CONTENTFUL_SPACE=
# your content delivery API token
export CONTENTFUL_CDA_TOKEN=
# your content delivery API token
export CONTENTFUL_CMA_TOKEN=
```
### Import data to your contentful space
```sh
$ npm run setup
```
## Development
To run your Remix app locally, make sure your project's local dependencies are installed:
```sh
$ npm install
```
Afterwards, start the Remix development server like so:
```sh
$ npm run dev
```
Update your local typescript definitions for your content types. This step is only needed If you change content types in the associated space.
```sh
$ npm run generate
```
Open up [http://localhost:3000](http://localhost:3000) and you should be ready to go!
If you're used to using the `vercel dev` command provided by [Vercel CLI](https://vercel.com/cli) instead, you can also use that, but it's not needed.
## Deployment
This project is bootstrapped with `npx create-remix@latest` and can be deployed to [vercel](https://vercel.com/).