Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 1.97 KB

README.md

File metadata and controls

55 lines (33 loc) · 1.97 KB
TeacherFund logo

TeacherFund is a charity to support teachers in a way that encourages great teachers to stay, and potentially great teachers to choose teaching as a career path. This includes providing supplemental funds and supplies to school teachers in need.

This repository contains the code for the main TeacherFund website

macOS

To build and view the site locally:

brew update
brew install node
npm install
echo -e echo -e "NEXT_PUBLIC_DEVELOPMENT=1\nENCRYPTION_SECRET=<the_space_needle_is_gorgeous_this_time_of_year>" >> .env.local
npm run dev

The generated site is available at `http://localhost:3001`

Contributing

We welcome any contributions to this project!!

If you're interested in fixing bugs or implementing new features, please see the document How to Contribute.

Building & Viewing

cd into the directory where you cloned this repository, update brew with the latest node version with brew update then install node with brew install node. Then install the node packet manager with npm install.

`It might take around 5 minutes at first if you do not have node or have a deprecated version on your system'

create a local environment file with echo -e "NEXT_PUBLIC_DEVELOPMENT=1\nENCRYPTION_SECRET=<the_space_needle_is_gorgeous_this_time_of_year>" >> .env.local You can swap the provided encryption secret with any 32 bit char string.

Start the server in the current directory

npm run dev

The generated site is available at http://localhost:3001

Styles

  1. Types
  2. References

Types

  • 1.1 Primitives: You must work directly on its value when you access a primitive type.

License

MIT