RomanHauksson / academic-project-astro-template

Simple project page template for your research paper, built with Astro and Tailwind CSS
https://research-template.roman.technology
272 stars 15 forks source link
astro research template

Research project page template

This is a template you can use to build a project page for your research paper, adapted from the original Nerfies page. It's designed to be easy to set up for those without web development experience, but web developers will appreciate that it's flexible and built with modern, familiar technologies. See a live demo of the template here.

Features

Real-world examples

Usage

Need help setting it up? Please schedule a call with me here, and I'll personally walk you through making your project page live! I want to talk to potential users to figure out pain points and features to add.

  1. Install Node.js.
  2. Click "Use this template" to make a copy of this repository and then clone it, or just clone it directly.
  3. Run npm install from the root of the project to install dependencies.
  4. Edit the content in /src/pages/index.mdx, and remember to update the favicon at /public/favicon.svg and the social link thumbnail (optional) at /public/thumbnail.png.
  5. Run npm run dev to see a live preview of your page while you edit it.
  6. Host the website using GitHub Pages, Vercel, Netlify, or any other static site hosting service.

Deploy to Netlify Deploy with Vercel

Notes

Credits

This template was adapted from Eliahu Horwitz's Academic Project Page Template, which was adapted from Keunhong Park's project page for Nerfies. It's licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.