Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.89 KB

README.md

File metadata and controls

53 lines (33 loc) · 1.89 KB

NCKU ARCH 80th Anniversary

This is the source code for the NCKU ARCH 80th Anniversary website.

🚀 Project Structure

The project is built using Astro.js and Tailwind CSS. Here's a quick look at the project structure:

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI

alternatively, you can use yarn to run the commands.

Deployment

Use docker to deploy the website.

docker build -t ncku-arch-80th-anniversary .
docker run --rm -p 8080:8080 ncku-arch-80th-anniversary

Disclaimer

This website is based on the Astro theme "Positivus" by Manul Thanura, which is based on Olga Averchenko's design.

Technologies

This project is tested with the following technologies:

  • yarn 1.22.19

📄 License

This project is licensed under the MIT License - see the LICENSE.md file for details