From 5911a4fd1aa27ef2f17005024735881f7205cdad Mon Sep 17 00:00:00 2001 From: Riley1101 Date: Mon, 5 Feb 2024 17:26:00 -0500 Subject: [PATCH 1/4] added readme file --- README.md | 61 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 36 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 3a357e6..32579e4 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,50 @@ -# create-svelte +# Shan Institute of Information Technology website -Svelte powered web -Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). +Hello! Glad to be a part of your SvelteKit project! We're using SvelteKit to make our web applications work really well. +For styling, we've got Tailwind CSS, and for managing content, we're using Sanity.io as our Content Management System (CMS). +If you have any questions or need help, feel free to ask! -## Creating a project +## Getting Started -If you're seeing this, you've probably already done this step. Congrats! +1. **Clone the Repository:** -```bash -# create a new project in the current directory -npm create svelte@latest + ``` + git clone https://github.com/shaniit-org/SIIT + cd SIIT + ``` -# create a new project in my-app -npm create svelte@latest my-app -``` +2. **Install Dependencies:** -## Developing + ``` + pnpm install + ``` -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +3. **Run the Development Server:** + ``` + pnpm run dev + ``` + This will start the development server. Open [http://localhost:5000](http://localhost:5000) in your browser to see the app. -```bash -npm run dev +## Features -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` +- **SvelteKit:** A powerful framework for building web applications with a focus on simplicity and ease of use. -## Building +- **Tailwind CSS:** A utility-first CSS framework for rapid UI development. Styles can be easily customized in the `src/global.css` file. -To create a production version of your app: +- **Sanity.io CMS:** A headless CMS that provides a flexible and structured way to manage content. Content models and data are stored in Sanity.io, and the app fetches data from the CMS to dynamically render content. -```bash -npm run build -``` +## Customize Sanity.io CMS -You can preview the production build with `npm run preview`. +If you are a contributor looking to modify the Sanity.io CMS: -> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. +- **Reach Out to Maintainers:** + - If you have ideas for improvements or want to modify the CMS schema, please reach out to the project maintainers. + - Create an issue on GitHub or contact maintainers through their preferred communication channels. + +## Contributing + +We welcome contributions to enhance the project! Please check the [Contributing Guidelines](CONTRIBUTING.md) for more information on how to get involved. + +## License + +This project is licensed under the [MIT License](LICENSE.md). From c0474458430a53f95d15e9d4def9e26435f5c21f Mon Sep 17 00:00:00 2001 From: Riley1101 Date: Mon, 5 Feb 2024 17:34:04 -0500 Subject: [PATCH 2/4] added image logo @ readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 32579e4..55e5c2e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ +

+ +

+ # Shan Institute of Information Technology website -Hello! Glad to be a part of your SvelteKit project! We're using SvelteKit to make our web applications work really well. +We're using SvelteKit to make our web applications work really well. For styling, we've got Tailwind CSS, and for managing content, we're using Sanity.io as our Content Management System (CMS). If you have any questions or need help, feel free to ask! @@ -29,7 +33,7 @@ If you have any questions or need help, feel free to ask! - **SvelteKit:** A powerful framework for building web applications with a focus on simplicity and ease of use. -- **Tailwind CSS:** A utility-first CSS framework for rapid UI development. Styles can be easily customized in the `src/global.css` file. +- **Tailwind CSS:** A utility-first CSS framework for rapid UI development. - **Sanity.io CMS:** A headless CMS that provides a flexible and structured way to manage content. Content models and data are stored in Sanity.io, and the app fetches data from the CMS to dynamically render content. From c257187665def66922450b15854f3595b891c3d9 Mon Sep 17 00:00:00 2001 From: Riley1101 Date: Mon, 5 Feb 2024 17:35:02 -0500 Subject: [PATCH 3/4] update on readme image size --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 55e5c2e..8f807df 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- +

# Shan Institute of Information Technology website From b65071d399cc5081f02631644ce236e25450c3ce Mon Sep 17 00:00:00 2001 From: Riley1101 Date: Mon, 5 Feb 2024 17:40:00 -0500 Subject: [PATCH 4/4] update on image text align and fix port number --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8f807df..6c90a8a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

-# Shan Institute of Information Technology website +# Shan Institute of Information Technology We're using SvelteKit to make our web applications work really well. For styling, we've got Tailwind CSS, and for managing content, we're using Sanity.io as our Content Management System (CMS). @@ -27,7 +27,7 @@ If you have any questions or need help, feel free to ask! ``` pnpm run dev ``` - This will start the development server. Open [http://localhost:5000](http://localhost:5000) in your browser to see the app. + This will start the development server. Open [http://localhost:5432](http://localhost:5432) in your browser to see the app. ## Features