/portfolio-creator-docs

Documentation for the Portfolio Creator v1 project

Primary LanguagePHP

LOGO

This project is a PHP-based portfolio creator that stores standardized data in a MySQL database. Additionally, it provides users with the ability to create their own custom templates.

Repo: https://github.com/abdalazard/PortfolioCreator

Current Project Status

  • Step 1 Completed: Implementation of the portfolio builder.
  • Step 2 Completed: working on the portfolio editing feature and deletion option.
  • Step 3 Completed: Developing the template system and the ability to select different styles.
  • Step 4 Completed: Testing - Working at
  • Step 5 Completed: Update user data modal.

Status

Contributions

This project is open source, and contributions are highly welcome! If you have ideas, suggestions, or corrections, feel free to open an issue or submit a pull request.

Technologies Used

  • Backend: PHP 7.4.33
  • Frontend: jQuery 3.5.1
  • Database: MySQL 8.0.30

How to Contribute

  1. Fork the repository

  2. Create a branch for your contribution (git checkout -b new-feature)

  3. Make desired changes and commit (git commit -m 'Adding new feature')

  4. Push to the branch (git push origin new-feature)

  5. Open a pull request.

What I need to know before start the project

    Create a .env file. In terminal line, write: touch db/.env. Now you’ll find the .env inside of db/ folder.

    Create a empty database for this project and then fill up the .env file with your database information:


      PROJECT_NAME = mydatabase
DB_HOST = localhost
DB_USERNAME = root
DB_PASSWORD = mypassword
MY_PORTFOLIO_NAME = mydatabase
MY_PORTFOLIO_PAG = https://my-website.com

      In terminal, install all dependencies: composer install

      For the last, in terminal command line you need to write the next command line for create your user access: php migrate.php

    Default user:


        Login: admin
Default password: 123

How to create and work your own template:

On the template preview page, you can create a new one by clicking the button "Create template". Upon entering the name and clicking create, a folder with three files (HTML, CSS and JavaScript) bearing the same name as your template will be created in the templates folder. You can edit these files and see the results on the template preview page.


I appreciate your contributions in advance!