aidang1 / baker

Baker College

Welcome to the Best College at Rice

View Site · Report Bug · Request Feature

Table of Contents

1. About
   • Built With
2. Hosted
3. Developing
4. Building
5. Testing
6. Sanity
7. Contributing

😈 About

This is the website for Baker College at Rice University created by Aidan Gerber. Baker has a long history of being the best and this website does nothing less than continue that legacy.

🏗️ Built With

• Svelte
• Sanity
• TypeScript
• Cloudflare Pages

⚡ Hosted Version

This website is currently hosted at baker.pages.dev. The Sanity studio is hosted at baker.sanity.studio. To edit website content make a Sanity account and contact me with your account and I will add you to the content editor.

⌨️ Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

🔨 Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

This app comes with the adapter for Cloudflare Pages but can be easily substituted for any hosting platform using a SvelteKit adapter.

🧪 Testing

This app comes with Playwright. To initialize Playwright on your machine:

npx playwright install

To run tests:

npm run test

🤖 Sanity

In the /baker directory is the Sanity instance. To use Sanity:

npm install -g @sanity/cli
npm install
sanity init
sanity deploy

😎 Contributing

Any contributions you make are greatly appreciated and help Baker a better place.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request