TikTok Harbor - Development Guide

Overview

This guide provides step-by-step instructions for setting up, developing and Deployment the TikTok Harbor website. The TikTok Harbor is built using SvelteKit, a framework for building website with Svelte.

Prerequisites

Before you begin, make sure your have the following installed on your development machine:

• Node.js (LTS version recommended)
• npm (Node Package Manager)
• Git

Getting Started

1. Clone the repository to your local machine:

git clone https://github.com/Onyx-Innovators/TikTok-Harbor.git

2. Change into the project directory:

cd TikTok-Harbor

3. Install the project dependencies:

npm install

Development

Running Locally

To run the website locally, use the following command:

npm run dev

This will start the development server. Open your web browser and visit http://localhost:5173/ to view the website.

Project Structure

• src/components: Reusable Svelte components.
• src/config: Configuration files.
• src/lib: Utility functions of external libraries.
• src/routes: Contains Svelte files for each page of the website.
• src/stores: Svelte stores for managing global state.
• src/utils: Utility functions for the website.
• static: Static assets such as images, videos, and other files.

Making Changes

1. Make changes to Svete files in the src directory.
2. Save your changes and the development server will automatically reload.

Deployment

Building for Production

To build the website for production, use:

npm run build

This will generates an optimized version of the website in the build directory.

Deploying Static Website

Ti deploy the website to a static hosting platform, use the following command:

1. Install the @sveltejs/adapter-static package:

npm install -D @sveltejs/adapter-static

2. Add the adapter to the svelte.config.js file:

import adapter from '@sveltejs/adapter-static';

export default {
    kit: {
        // ...
        adapter: adapter()
    }
};

3. Build the website for production:

npm run build

4. Deploy the website to the hosting platform.

[!NOTE] To deploy the website to other platforms, refer to the SvelteKit Adapters documentation.

Contributing

1. Fork the repository from GitHub.
2. Clone your fork to your local machine.
3. Create a new branch for your festure or bug fix.
4. Make your changes and submit a pull request.

Conclusion

This guild provides a basic setup for the development of the TikTok Harbor website. Customization and extent is based on your requirements. Always refer to the official documentation for the tools and frameworks used for more in-depth information.

For more information, refer to the SvelteKit documentation and the Svelte documentation.

License

The TikTok Harbor website is open-source and licensed under the MIT License.