Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exdst/jss-astro-public
Sitecore JavaScript Software Development Kit for Astro
https://github.com/exdst/jss-astro-public
astro headless jss sitecore
Last synced: 4 months ago
JSON representation
Sitecore JavaScript Software Development Kit for Astro
- Host: GitHub
- URL: https://github.com/exdst/jss-astro-public
- Owner: exdst
- License: apache-2.0
- Created: 2023-08-09T10:48:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-28T13:52:52.000Z (5 months ago)
- Last Synced: 2024-10-09T15:09:21.248Z (4 months ago)
- Topics: astro, headless, jss, sitecore
- Language: TypeScript
- Homepage:
- Size: 1.01 MB
- Stars: 20
- Watchers: 7
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Sitecore JavaScript Software Development Kit for Astro
[](CONTRIBUTING.md)
This project is an implementation of Sitecore JavaScript Services Software Development Kit(SDK) for Astro. It contains Astro components and integration for JSS.
It is fully featured SDK. You can use it to build your website with Astro and Sitecore.
## Project structure
* [Astro JSS SDK](./astro-sitecore-jss/packages/astro-sitecore-jss/)
* [Astro sample project](./astro-sitecore-jss/packages/astro-sitecore-jss-sample/)
* [Astro project initializer](./astro-sitecore-jss/packages/create-astro-sitecore-jss/)
* [Sitecore](./sitecore/)
## Development usage
1. Initialize and start Sitecore instance. Please, follow instruction under [Sitecore](./sitecore/README.md) folder to setup Sitecore instance.
2. Open Sitecore Content Editor and check that there is a new SXA managed headless website under path `/sitecore/content/Headless/Astro`
3. Check your Node version using command `node -v`. If version is lower than 18, please, update it to LTS version 18+.
4. Change directory to the [Astro SDK project](./astro-sitecore-jss/packages/astro-sitecore-jss/) `cd ./astro-sitecore-jss/packages/astro-sitecore-jss/`
5. Install npm packages with `npm install`
6. Change directory to the [Astro sample project](./astro-sitecore-jss/packages/astro-sitecore-jss-sample/) `cd ./astro-sitecore-jss/packages/astro-sitecore-jss-sample/`
7. Install npm packages with `npm install`
8. Start the project with `npm run dev` command
9. Open [http://localhost:4321](http://localhost:4321) in your browser (If port 4321 is busy, different port will be used)
10. Open Sitecore Experience Editor for item `/sitecore/content/Headless/Astro/home/styleguide`
## Production usage
### Installation for production usage
1. Create Sitecore Headless website. You can use any approach:
* [SXA managed approach](https://doc.sitecore.com/xp/en/developers/sxa/102/sitecore-experience-accelerator/create-a-headless-tenant-and-site.html)
* Config manages site
1. Open command line
1. Run `npx @astro-sitecore-jss/create-astro-sitecore-jss@latest`
1. Follow instructions
1. Change directory to the created project
1. Start website with `npm run dev`
### Production build
1. Run `npm run build` command to build the project
1. Copy `./dist` folder to your web server
Astro support deployment to many platforms. Please, follow [Astro documentation](https://docs.astro.build/en/guides/deploy/) to deploy your website.
Some examples:
1. [Netlify](https://docs.astro.build/en/guides/deploy/netlify)
1. [Vercel](https://docs.astro.build/en/guides/deploy/vercel)
1. [AWS](https://docs.astro.build/en/guides/deploy/aws/)
1. [Azure](https://docs.astro.build/en/guides/deploy/microsoft-azure/)
## Installation for development and contribution
### Sitecore
Currently, project supports only Sitecore first approach. You are not able to push items to Sitecore from code.
Please, follow instruction under [Sitecore](./sitecore/README.md) folder to setup Sitecore instance.
It is Docker based, so you can easily run it locally with a few commands.
## NPM packages
* [Sitecore JSS Astro SDK](https://www.npmjs.com/package/@astro-sitecore-jss/astro-sitecore-jss)
* [Astro project initializer](https://www.npmjs.com/package/@astro-sitecore-jss/create-astro-sitecore-jss)
## Contacts
If you would like to see demo, please, contact
* [Email](mailto:[email protected])
* [LindedIn](https://www.linkedin.com/in/anton-tishchenko-b45b2923/)
## Contributors
* Anton Tishchenko, [GitHub](https://github.com/antonytm), [LinkedIn](https://www.linkedin.com/in/anton-tishchenko-b45b2923/)
* Bogdan Druziuk, [GitHub](https://github.com/bdruziuk), [LinkedIn](https://www.linkedin.com/in/bogdan-druziuk-50069763/)
* Oleksandr Melnyk, [GitHub](https://github.com/OlekMel)
* Stanislav Chernetsky, [GitHub](https://github.com/stanislavSV)
* Vasyl Gavrylyuk, [GitHub](https://github.com/vsegrad)
Sponsored by [EXDST](https://exdst.com/)