Suburbia

An awesome 3D skateboard landing page website
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

Welcome to the Suburbia Github repository! Here, you'll find the source code for our sleek and sophisticated 3D skateboard landing page website. Built with modern technologies and a focus on user experience, our website aims to provide customers with an effortless website surfing experience.

back to top

Built With

Main technology used to built this application are listed below:

• Typescript
• Next.js
• Tailwind CSS
• GSAP
• Three.js
• Prismic

back to top

Getting Started

To get started with this project locally, follow below steps:

Prerequisites

Make sure you have Node.js, and package manager (either npm or yarn) installed

FYI: This project uses npm as the package manager, but you're free to use yarn too.

Installation

Below steps will guide you through the local installation process of this application

1. Clone the repo

   git clone https://github.com/blesten/3d-landing-page.git
   

2. Open your terminal, and cd to the root directory, then run npm install command to install dependency
3. Lastly, run npm run dev command on root directory at your terminal to start the application

back to top

Contributing

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 with the tag "enhancement". 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

back to top

License

Distributed under the MIT License. See LICENSE.txt for more information.

back to top

Contact

LinkedIn: Stanley Claudius

Project Link: https://github.com/blesten/3d-landing-page

back to top

Acknowledgments

Special thanks to:

• Othneildrew for providing an amazing README template.
• Tailwind CSS for providing CSS framework to be used in this application.
• React Icons for providing icon to be used in this application.

back to top