Skip to content

weebik/weebsite

Repository files navigation

Stargazers Issues MIT License LinkedIn


Logo

weebsite

This is my personal fullstack project that serves as my web CV.

Visit · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Contributing
  3. License
  4. Contact
  5. Todo

About The Project

This project is built with React framework using TypeScript. Some components are from MaterialUI and the styles are written in pure css. The backend and CMS is based on Strapi with various plugins like Internationalization and EmailPlugin. Frontend is deployed on Vercel, backend is deployed on Render. The backend has been linked to Supabase Database that stores content of the website.

(back to top)

Built With

React Typescript CSS Strapi MUI Vercel Render Supabase

(back to top)

Project Structure

weebsite/
├── backend/
│   ├── public/
│   ├── src/
│   │   └── api/
│   └── types/
└── frontent/
    ├── public/
    ├── src/
    │   ├── assets/
    │   ├── components/
    │   ├── hooks/
    │   ├── layout/
    │   ├── pages/
    │   ├── routes/
    │   ├── styles/
    │   ├── types/
    │   ├── utils/
    │   ├── App.tsx
    │   ├── index.css
    │   └── main.tsx
    └── index.html

(back to top)

Contributing

Thank you for your interest in contributing to my project! Your feedback and suggestions are invaluable in making this app better. Below are some ways you can contribute:

(back to top)

Reporting Issues

If you find any bugs or issues, please let me know by creating a GitHub issue. When reporting, try to include:

  • A clear description of the issue.
  • Steps to reproduce the problem.
  • Screenshots or error messages, if applicable.

(back to top)

Suggesting Improvements

Your ideas on how to improve the project are always welcome! Feel free to:

  • Suggest ways to optimize the code for better performance.
  • Propose changes to make the code more readable and maintainable.
  • Recommend new features or enhancements that align with the project's goals. You can do that via Request feature form.

(back to top)

License

  • Backend uses the MIT Expat license. Details in LICENSE.
  • Frontend uses the MIT license. Details in LICENSE.
  • The content of the site (e.g. texts, media) is my property and cannot be copied without my permission. The exception is the background video animation, which belongs to 4k SCREENSAVERS.

(back to top)

Contact

Krystian Ćwikliński - [email protected]

Project Link: https://github.com/weebik/weebsite

(back to top)

Todo

  • Improvments in mobile views and responsiveness
  • Some style changes (animations, icons)
  • Code refactor
  • React hook form (?)

(back to top)