-
Notifications
You must be signed in to change notification settings - Fork 6
Setup
Welcome to Sledge! We are so excited that you are working with us.
Sledge is a full-stack web application that is split into two parts- the client (aka frontend) and the server (aka backend). These two parts are set up separately, and are connected when the frontend makes a request to the server.
Sledge relies on Node Package Manager (aka NPM) to install and keep track of packages, and uses MongoDB for the database. You need to install those onto your system before setting up Sledge.
Take a look here.
Take a look here.
- FOR WINDOWS USERS: Note that you generally want to install MongoDB as a service. This will start up the MongoDB service in the background whenever you turn on your computer. Additionally, after installing MongoDB, you should add MongoDB to your system PATH so that you can open the Mongo shell in a single command.
To get the code for Sledge, you'll need to clone the Sledge repository. To do so, run:
git clone https://github.com/HackRU/sledge.git
Then you can enter the repository (that is now on your computer) with:
cd sledge
Here's how to set up the frontend:
- Go into the frontend directory:
cd client
- Install the node dependencies:
npm i
- Create a copy of the
.env.example
file, and name the copy.env
:cp .env.example .env
- Start the web app:
npm start
And in your web browser, if you open localhost:3000
(if it didn't already automatically open), you'll see the spinning React.js logo.
The backend is set up similarily to the frontend:
- Go into the backend repository.
- Install the node dependencies:
npm i
- Start the server:
node server.js
Whenever you run into an issue, try searching your error up on Google! It has most likely been encountered by other people as well. But as usual, don't be afraid to ask your project lead any questions!
Welcome
Using Sledge
Development
Archive