WELCOME

Show your projects

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contact

About The Project

Home Page

Projects Catalog

Project Page

Messages Catalog

Message Page

User Page

Show Your Project - A Platform to Share Your Creativity with the Community

Introduction

Welcome to Show Your Project – a platform where you can showcase your projects, whether they are web applications, graphic designs, or other creative works. Our goal is to provide a space where you can share your ideas, connect with others, and receive feedback on your work.

You can not only post and describe your projects, but also share messages and thoughts with the community. Each post includes the ability to receive likes, views, and comments. Additionally, you can interact with others by liking their posts and projects, and you can track the number of views each one receives. The platform ensures a dynamic interaction between users by enabling full CRUD (Create, Read, Update, Delete) operations on posts.

Key Features

• **User Profiles: Users can create and manage their own profiles to track their projects and interactions.

• **Post & Project Sharing: Share your work with the community and receive feedback through likes and views.

• **Likes & Views Count: Every post and project displays the number of likes and views to highlight user engagement.

• **Filtering & Pagination: Easily browse through projects with powerful filtering options and pagination for improved user experience.

• **CRUD Operations: Full control over your posts – you can create, edit, and delete your posts and projects.

• **Responsive Design: The platform is designed with a responsive layout to ensure seamless user experience on any device.

• **Secure User Management: We use Clerk for secure user authentication and account management.

Development Process

This platform was developed using a variety of modern technologies, including Next.js for server-side rendering and routing, TypeScript for type safety, TailwindCSS for styling, Node.js and Express for the backend, and Sequelize as the ORM connected to a PostgreSQL database.

Our development process emphasizes clean, maintainable code and an intuitive UI to deliver a seamless user experience.

Conclusion

"Show Your Project" isn't just a place to post your work – it's a community for creators to share, collaborate, and grow together. Whether you're an experienced developer, a designer, or a hobbyist, this platform offers the perfect space to connect with like-minded people and showcase your projects.

(back to top)

Built With

• - A React framework for server-side rendering and static site generation.
• - A utility-first CSS framework for building responsive and modern designs.
• - A JavaScript runtime built on Chrome's V8 JavaScript engine.
• - A minimalist web application framework for Node.js.
• - A powerful authentication and user management solution.
• - A promise-based Node.js ORM for PostgreSQL, MySQL, SQLite, and MSSQL.
• - A powerful, open-source object-relational database system.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone [https://github.com/your_username_/Project-Name.git](https://github.com/PL-FE-SEP23-JANUSZ3X/product_catalog.git)

2. Install NPM packages

   npm install

3. Start

   npm run dev

4. Enter your API in .env

(back to top)

Contact

Patryk Wierzbowski - linkedin, github

(back to top)