Git Product home page Git Product logo

kristi11 / portfoliowebsite Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 791 KB

This is a modest CMS created for developers worldwide to display their professional skills. Although it may not be the flashiest personal/portfolio website you've come across, it is straightforward and efficient.

License: MIT License

PHP 42.69% JavaScript 0.24% CSS 0.02% Blade 57.05%
laravel laravel-livewire open-source personal-website portfolio-website tailwindcss

portfoliowebsite's Introduction

Status

  • Actively being updated.

About this app

This is a modest CMS created for coders worldwide to display their professional skills. Although it may not be the flashiest personal website you've come across, it is straightforward and efficient. This app utilizes the powerful laravel jetstream with the livewire stack.

To do:

  • Create Models, migrations and livewire components for each model
  • CRUD for each model
  • File uploads/downloads for the resume section
  • Finalize user dashboard information
  • Finalize toaster notification system
  • Secure mailto: links
  • Design and integrate public user profile. This profile will be shown to everyone.
  • Integrate dark mode
  • Add real-time validation to livewire components
  • Add subscribe to newsletter functionality

Need to know

  • If you just installed the app you will be directed to a user registration form right away.
  • After signing up you will be required to verify your email address.
  • User registration will be disabled after the first user has been created.
  • User login is hidden from the public. You can access it by going to yourdomain.com/login.
  • After verification, you're free to use the app however you like.
  • 2-factor authentication is available for an added extra layer of security, but it is not required. You can use an authenticator app like Google Authenticator.
  • This app has support for dark mode based on system preference.
  • If you're working on a local environment and your profile picture does not display make sure to update the APP_URL in your .env file to APP_URL=http://localhost:8000 or whatever local environment link you're using.

If you need help getting things started, contact me. I'll be happy to help.

Showcase

Few things to keep in mind

  • I was having some computer issues at the time of recording so the app might look a little laggy.
  • The screen recorder wouldn't record the upload/select forms so that's why you don't see them in the video.
  • The public profile thats being showcased is a very simplified version of the actual public profile since i was simply showing the functionality of the app. To get a more accurate idea of how the public profile looks like you can visit my up and running personal website at kristitanellari.com

Check out the screencast here

Getting started

Add a .env file and copy the contents from the .env.example file inside your project root. This will enable all the necessary app information. Open the console and cd into your project root directory.

  • Run composer install to install necessary files

  • Run npm install to install necessary files

  • Run npm run build(if working on a live server) or npm run dev(if working on a local server) to compile the necessary files.

  • You may have to run npm audit fix to fix any npm vulnerabilities.

  • Run php artisan key:generate to generate a unique app key.

  • Run php artisan migrate:fresh. This will migrate a fresh copy of all of the necessary database files.

  • Run php artisan storage:link to create a symbolic link from public/resumes to storage/app/resumes which will allow you to access files stored in storage/app/resumes from the browser.

  • On analytics.blade.php enter your analytics id instead of YOUR-GOOGLE-ANALYTICS-ID

  • To login to your app you will need to verify your email, so in order to do that you will need to setup an email server. I recommend using mailhog. The easiest way to get it up and running locally is to download the mailhog .zip file, run it and update the .env file with the following information: MAIL_HOST=localhost. The default value might be MAIL_HOST=mailpit

  • To enable subscribing to the newsletter you will need to create a mailchimp account and update the .env file with the following information:

    • MAILCHIMP_KEY=your mailchimp key
    • MAILCHIMP_LIST_SUBSCRIBERS=your mailchimp list subscribers id
    • MAILCHIMP_SERVER_PREFIX=your mailchimp server prefix
  • If your do not know how to set up your API key and the necessary steps to get started with mailchimp you can check the mailchimp's quickstart guide

  • Run php artisan serve to boot up the app (if working on a local server).

To optimize the performance you can run the following commands

  • php artisan config:cache - to cache the config file
  • php artisan route:cache - to cache the routes
  • php artisan view:cache - to cache the views

You can find more info on laravel caching here

Have fun with your new app!

portfoliowebsite's People

Contributors

kristi11 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.