README.md

UF Open Source Club's Website

The official remodeling of the official club website.

The website needs to be a central place for

• Potential club members who are interested in what the Open Source Club is and want to find out more
• Existing club members as a way to easily check what events are happening and what projects the club is working on
• Students or others who are interested in open source in general and want to see how UF is involved with Open Source

The project roadmap can be found here.

Getting Started

Install

• An internet browser like Firefox or Google Chrome
• An IDE or text editor like WebStorm, VSCode, Atom, or Sublime Text
  • Install an EditorConfig plugin if available, to help ensure consistent formatting
• Node.js (whatever version is the latest, there shouldn't be any issues unless on an ancient version)

Then clone this repo

Verifying your installs

• run npm -v and node -v, these should output a version number along the lines of v10.16.0 or 6.11.3
• if these commands fail, make sure you have node.js properly installed.

Testing

If working with backend follow these instructions:

1. if you haven't already, run npm install once navigated into the club-wesbite/server directory.

2. Once completed, go ahead and run npm install nodemon -g, this will allow for automatic reloading of the server when you update your codebase.

3. Now run nodemon nodemon server/server.js.

4. The backend development server should now be running!

If working with the frontend follow these instructions:

1. if you haven't already, run npm install once navigated into the club-wesbite/client directory.

2. Run the command react-scripts start while still in the same directory.

Deployment

Our own Nginx server using the club stack project

Built With

• React - Used for the frontend, it helps define the layout into components and manage page elements/components dynamically.
• Node.js - Used on the backend, useful for HTTP protocol and uses an asynchronous event driven JavaScript runtime.
• Express - A Node.js framework with a plethora of HTTP utility methods and middleware.
• MongoDB - A document-based, NoSQL database.

Check out the DESIGN.md file in docs folder for more information about the project.

Contributing

Please read CONTRIBUTING.md for how to work on the project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details