search

develop-me / bagajob

Job Hunting Management App built by Develop Me students for Develop Me students.
https://bagajob.developme.space
GNU Affero General Public License v3.0
1 stars 2 forks source link
axios css heroku html javascript laravel php react redux redux-thunk sass

readme

Bagajob App

Job Hunting Management App built by Develop Me students for Develop Me students.

Code of Conduct

Available here: https://github.com/develop-me/bagajob/wiki/A-Code-of-Conduct-for-Open-Source-Projects

Front-end Architecture - React Redux

Collaborating:

Never commit directly to the master branch. Create a new feature branch from the development branch, and make a pull request for a team-mate to review and merge.

NOTE: At least ONE (1) other Team Member must approve your Pull Request before merging (whether the merge is from feature-branch to development, or from development into master)

Our workflow process is as follows:

  1. Create a new feature branch (e.g. footer-styling) from the development branch

  2. Make your changes on your feature branch

  3. Open a Pull Request to merge the feature branch into development describing the changes made

  4. Wait for another collaborator to approve your PR

  5. Merge your completed feature branch into development

  6. Branch again from development for your next feature (e.g. header-styling)

  7. Repeat

  8. The development branch should only be merged into master once a new build/release and all its features are complete and ready to deploy (see below for deployment instructions)

  9. The master branch is deployed to the server. Only merges from development should be committed to this branch (excepting edits to documentation)

Getting Started:

  1. Clone the repository to your local machine using the URL in the Repo

    git clone {url} {foldername}

  2. Install neccessary packages using npm

    npm install

  3. Find a new issue in this repository to work on

  4. Create a branch on your local machine to work on that issue/feature

    git checkout -b {name of branch}

  5. Develop your features in your feature branch, and test on your local machine

  6. Once you're happy with your branch push your branch to the remote repo on gitHub

    git push origin {branch}

  7. In gitHub create a pull request for your new branch to merge into the development branch, assign a reviewer and link the issue you were working on

  8. Have a team member review the pull request and merge!

  9. Ensure the branch is deleted once its merged

    Running and using the App locally

  10. Run npm start

  11. Visit the local development server in your browser

    Developing Styling

This application is styled using SASS. All .scss files (src/scss/example/_example.scss) are imported (@import) into src/scss/main.scss, before being compiled to src/css/styles.min.css.

In order to compile SASS to CSS, run the following command in the project root:

sass src/scss/main.scss src/css/styles.min.css

In order to configure SASS to compile every time changes are saved to a SASS file, run:

sass --watch src/scss/main.scss src/css/styles.min.css

Please note that changes to SASS files will not show in the app until compiled to src/css/styles.min.css.

API Set Up

Current Steps

(These could definitely be optimized)

NOTE: Currently the development branch is active on the host, this will be changed to to master (run git checkout master) upon deployment when ssh'd into the server

Create React App Documentation

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify