Code Monkey home page Code Monkey logo

josephpalma.dev's Introduction


Logo

josephpalma.dev - v2

Website Status Heroku Status License Last commit

The second iteration of my portfolio website built with React and hosted with Heroku

Previous iterations: v1

DEMO »

Table of Contents
  1. Forking
  2. Getting Started
  3. Build and Run for Production
  4. Contributing
  5. License
  6. Contact

🚨Forking This Repository

Yes, you may fork this repository. Please star this repo and give proper credit by linking back to josephpalma.dev. Thank you!

Note that this project was not intented as a starter theme.

Built With

  • MaterialUI For theming and styles.
  • React For a component based UI.
  • Node Enables features like the email service.
  • MongoDB Allows for easy JSON content management.

Color Reference

Color 🎨 Hex
Black #121212  

White #f7f7f7  

Blue #366194  

Cobolt #232c36  

Light Blue #6B93CE  

Error #B1161E  



🔨 Getting Started

Prerequisites

Install Node.js with the installer

Once installed, verify by checking the installed version:

node -v or node –version

Installation

  1. Clone the repo
    git clone https://github.com/josephpalma/professional-portfolio
  2. Navigate to the /client directory
    cd professional-portfolio/client
  3. Install NPM packages
    npm install
  4. Repeat steps 2 and 3 for the /server directory
    cd .. && cd server && npm install
  5. Start the development server
    cd .. && cd client && npm start

Configure

  1. Use your own data by replacing all endpoints in /client/src/assets/api/ with your own data sources.

  2. Generate a secure 160-bit WPA or higher API Key using https://randomkeygen.com/

  3. Create your frontend .env and paste this code, replace key with your custom generated key:

    REACT_APP_cryptoKey=your custom generated key
  4. Create your backend .env and paste this code, replacing with your own info:

    dbUri=mongodb+srv://your mongo db uri
    cryptoKey=your custom generated key
    emailService=your email service (note: gmail will not work here)
    [email protected]
    emailPass=senders email password

🛠 Build For Production

Simple build

Runs the standard React build script and generates a full static production build in /client.

npm run build

Build Package

Assembles a build package in the root directory's /build folder. The app is now ready to be deployed from the /build directory.

npm run build-package

Note: This command only runs on Windows. Consider contributing build commands for your OS of choice.


🚀 Deploy

Before you deploy, make sure to provide all the enviroment variables from the Configure Project section to your hosting service.

To deploy to Heroku, make sure you've set up a Heroku application, and downloaded the CLI. Read more information on deploying to Heroku with Git, here.

You can deploy to Heroku with this command, or replace the contents of scripts.deploy in client/package.json with your own deployment script. To deploy with Heroku, from the /client directory, run:

npm run deploy

Note: This command only runs on Windows. Consider contributing deploy commands for your OS of choice.



Contributing

If you have a suggestion that would make this portfolio better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.


Contact

Joseph Palma - Linked In - [email protected]

(back to top)

josephpalma.dev's People

Contributors

josephpalma avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

granga

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.