Skip to content

Latest commit

 

History

History
102 lines (67 loc) · 3.23 KB

README.md

File metadata and controls

102 lines (67 loc) · 3.23 KB

Dax Website

View the live website at daxcastellon.dev

This is a personal website which purpose is to show my skills on Web Development. It is always improving and I make updates consistently trying new methods. You can use it as an example or to review my code.

Please, don't use it as your own. That is not cool.

The website is built with Next.js

Installation

  • Copy or clone this repository on your local environment.
  • Install dependencies by running
npm run install

I keep the repository updated but you can always update the dependencies with

npm run update
  • Run the development server:
npm run dev
# or
yarn dev

You editing the pages by modifying files in the directory pages/. The page auto-updates as you edit the file.

File Structure

The file structure is as follows:

  • components: list of React components used
  • data: example data in JSON format. This is going to change soon.
  • libs: libraries. At this moment there is only the FontAwesome icons.
  • pages: the pages of this website
  • public: static files such as fonts and images
  • styles: global SASS styles
  • .gitignore: list of files to be ignored when uploading to this repository
  • next.config.js: basic NextJs configuration
  • package.json: list of node packages needed for development
  • README.md: this file

CSS Styling

  • The styling process is built with SASS. You can find the basic global styles in the directory styles/global/
  • There are some global styles that like variables, mixins, fonts and a CSS reset. Those styles are found in styles/settings/
  • React components styles are found in the same directory of the component. I.E. components/alert/Alert.module.scss

Sendig Email Messages

This website uses EmailJS as the Email service. To use EmailJS:

  • Create an account in EmailJS
  • Once logged in, create a new Email Service and select your Email provider
  • Create a .env.local file with the following variables:
    • NEXT_PUBLIC_EMAILJS_USER=replace with your EmailJS user ID
    • NEXT_PUBLIC_EMAILJS_TEMPLATE=replace with your EmailJS template ID
    • NEXT_PUBLIC_EMAILJS_SERVICE=replace with your EmailJS service ID

Deployment

Static HTML

Run:

npm run build

By default, this will generate an out directory, which can be served by any static hosting service or CDN.

Node.js Server

You can use any cloud platform with node.js. Every provider has its own methods but in general you should be able to upload this website using your Git provider of your choice.

  • Create a repository in your Git provider and upload these files
  • Configure your cloud provider to deploy the branch of your choice of this repository

Roadmap

I am working on the following:

  • Reduce code by implementing best code practices
  • Integrate Typescript

Learn More

To learn more about Next.js, take a look at the following resources: