Skip to content

Latest commit

 

History

History
256 lines (167 loc) · 11 KB

README.md

File metadata and controls

256 lines (167 loc) · 11 KB
Raw

[rev0] - DevFolio Template

Contributors Forks Stargazers Issues

A powerful and flexible developer portfolio template integrated with a content management system (CMS). Built with modern technologies, rev0 Devfolio Template is designed to make it easy for developers to showcase their work and create custom pages using pre-built blocks. This template also includes a blog feature and is fully customizable, allowing you to personalize the design and content.

View Demo . Report Bug · Request Feature

Features

  • Content Management System (CMS): Easily manage your content using the integrated Payload CMS.
  • Blog: Share your thoughts and updates with the built-in blog feature.
  • Page Builder: Quickly assemble custom pages with pre-built, customizable blocks.
  • Easy Deployment: Deploy the portfolio effortlessly to platforms like Vercel or Netlify.
  • User-Friendly Management: Simple and intuitive interface for updating and organizing content.

(back to top)

Technologies Used

  • SQLite: Lightweight database for fast and reliable data storage.
  • Next.js: Framework for server-rendered React applications.
  • React: JavaScript library for building user interfaces.
  • Payload CMS: Integrated CMS solution for managing content seamlessly.
  • Tailwind CSS: Utility-first CSS framework for custom styling.

(back to top)

Installation

  1. Clone the Repository
    Clone this repository to your local machine and navigate to the project folder.

  2. Set Up Environment Variables
    Copy the .env.example file and rename it to .env.
    Update the .env file with the following values:

    DATABASE_URI=file:./.db
PAYLOAD_SECRET=b48597b03a8d348d7e798b6c

    This configuration will connect the application to the preloaded SQLite database included in the repository, allowing you to access and edit the existing template content.

  3. Install Dependencies
    Run the following command to install the required packages:

    npm install

  4. Start the Development Server
    Run the following command to start the application in development mode:

    npm run dev

  5. Access the CMS Dashboard
    Open your browser and navigate to http://localhost:3000/admin.
    Log in with the following credentials:

    You can now start editing the template to suit your portfolio needs.

(back to top)

Usage

  1. Log in to the CMS dashboard.
  2. Use the Pages section to create or edit pages, leveraging the pre-built blocks for easy customization.
  3. Customize the look and feel using Tailwind CSS and React components.

(back to top)

Troubleshooting

For common issues, refer to the Payload CMS documentation and Next.js guides. Known issues and potential solutions may be listed in the Issues section on GitHub.

Here's the roadmap section formatted as requested:

Roadmap

  • Blog Section
  • Custom Layouts
  • Technical SEO Implementation
  • Add Dark Mode
  • Add New Blocks
    • Project Showcase
    • Testimonials
    • Contact Form
    • Interactive Media Sections
  • Add Animations
    • Page Load Animations
    • Hover Effects for Links and Buttons
    • Smooth Scrolling and Transitions for Block Elements

See the open issues for a full list of proposed features and known issues.

This format allows for easy tracking of progress on each feature and offers a clear view of future updates. Let me know if there are additional details you'd like to include!

(back to top)

Contributing

Contributions to rev0 Devfolio Template are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature (git checkout -b feature/YourFeatureName).
  3. Commit your changes (git commit -m 'Add a new feature').
  4. Push to the branch (git push origin feature/YourFeatureName).
  5. Open a pull request to merge your feature into the main branch.

Top contributors:

contrib.rocks image

(back to top)

License

This project is licensed under the MIT License with additional restrictions:

Resale and Relicensing Restriction: The Software, or any derivative works thereof, may not be sold, relicensed, or rented as a service by any party other than Glozinfinity Technology Private Limited. For more details, refer to the LICENSE file included in the repository.

(back to top)

Contact

uluckydev - @uluckydev - [email protected]

Project Link: https://github.com/glozinfinity/rev0-portfolio

(back to top)

Acknowledgments

Thanks to the open-source community and contributors for helping improve and maintain the rev0 Devfolio Template.

(back to top)