Welcome to the Sparky Solutions repository! This website was built using Next.js and pure CSS, with the help of the styled components library for a single reusable React component. The site is fully responsive and features three pages: home, about, and contact us. It is hosted at https://whoknowsi.github.io/sparky-solutions/.
Sparky Solutions is designed to be responsive, adapting to different screen sizes and resolutions. Here are some examples of how the website looks on different devices:
To get started with this project, follow these steps:
- Clone the repository:
git clone https://github.com/whoknowsi/sparky-solutions.git
- Install the dependencies:
npm install
- Create a
.nojekyll
file in the root directory of the repository:touch .nojekyll
(on Windows, you can usetype nul > .nojekyll
) - (Optional) If you want to deploy the website to GitHub Pages, update the
homepage
field in thepackage.json
file to match the URL of your GitHub Pages site (e.g."homepage": "https://whoknowsi.github.io/sparky-solutions/"
). This field is not necessary for development or testing the site locally. - Start the development server:
npm run dev
This project includes several scripts to help you develop, build, and deploy the website:
dev
: Start the development serverbuild
: Build the website for productionexport
: Export the built website to static HTML filesstatic
: Build and export the websitestart
: Start the production serverlint
: Lint the code using ESLintdeploy
: Deploy the built website to GitHub Pagesdeploy:full
: Build, export, and deploy the website
Note: The export
, static
, and deploy:full
scripts require a .nojekyll
file in the root directory of the repository. This file is used to copy the _next
directory and its contents to the out
directory, which is necessary for GitHub Pages to correctly import the JavaScript and CSS files when deploying the site.
Note: The scripts in this project are designed to work with Windows. On Linux or macOS, you may need to use a different command to create the .nojekyll
file (e.g. echo "" > .nojekyll
).
- Next.js - A framework for building server-rendered React applications
- styled components - A library for styling React components with CSS
- ESLint - A tool for linting JavaScript code
- react-copy-to-clipboard - A React component for copying text to the clipboard
- react-icons - A library of SVG icons for React
- react-select - A flexible and customizable select component for React
This project is licensed under the MIT License - see the LICENSE file for details.