/Liv2BGirl

A social media platform focused on positive support for young women.

Primary LanguageJavaScriptMIT LicenseMIT

Liv2BGirl

Stack

  • React.js: Front-end
  • Next.js: API routes and server-side rendering
  • MongoDB: Permanently storing info
  • eslint: Automatically identifying and fixing code errors
  • prettier: Setting a common code style and fixing any issues

Running

MongoDB

A running instance of MongoDB is required this project.

  • By default, development uses MongoDB on your computer, if you would like to use an external database, enter export MONGO_DEV_DB='URLHERE' (macOS/Linux) or setx MONGO_DEV_DB URLHERE (Windows) and skip the instructions below.
  • Download MongoDB Community Server
  • Go through the installation instructions.
    • Atlas is recommended for basic testing.
    • Leave the port at default 27017
  • Create the liv2bgirl database. (or choose another name, but make sure to change it in utils/urls.js)
  • You're done!

Development

  • Setup MongoDB with the instructions above
  • Clone this project to your computer
  • Navigate to this project in terminal and enter npm install
  • Setup development environment variables by running npm run secrets
    • You will be prompted for a password. Ask your EM to send it to you.
    • NOTE: Windows users need to run npm run secrets:login and npm run secrets:sync instead
  • Run the dev version of this project by entering npm run dev

Styling

  • By default, this repository uses Next 9.2.0 for styles, which includes native support for global CSS and CSS modules
  • However, this version only allows global css to be in pages/_app.js, which can cause issues with external packages
  • If you face this error, the solution is installing @zeit/next-css and adding it to next.config.js, however you cannot use css modules and global css together with this package (and it defaults to global).