Homec4science
Diffusion Open Access Compliance Check Tool (OACCT) (drf-api-tracking) Browse

rOACCT/assets/README.md
0fe302da06a2drf-api-tracking

Last Change
Raw File

README.md
View Options

# Getting Started with OACCT project
This Project is using Django and React on hybrid architecture.
source: `https://www.saaspegasus.com/guides/modern-javascript-for-django-developers/integrating-django-react/`
# Django_app
Django Project living in []./django_app]
contain:
`settings.py` Main app configuration
`urls.py` Main app urls
Django app is serving main urls, main template and the API using Django Rest Framework.
Main URL:
`http://127.0.0.1:8000/admin`
`http://127.0.0.1:8000/api` (web-interface->dev only!)
Main Template:
[./templates/assets/index.html]
Rest Framework documentation:
`https://www.django-rest-framework.org/`
To connect the frontend django is using Webpack configured as follows:
Main Configuration file to connect Django and the frontend
[./webpack.config.js]
Input Source frontend (React) app living in [./assets] folder
Input Frontend entry file [./assets/src/index.js']
Output Frontend files [./static/assets/]
# React app
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
The app is living in [./static/assets/index.html] --> <div id="app"></div>
Style and design using:
1. (https://react-bootstrap.github.io/)
2. (https://material-ui.com/)
Axios Component for React with child function callback:
(https://www.npmjs.com/package/react-axios)
https://github.com/axios/axios
## Available Scripts
In the project directory, you can run:
#### Django
### `Python manage.py runserver`
`http://127.0.0.1:8000/`
Runs the app in the development mode using SQL lite
### `production`
## `TODO`
Create settings/production:
- Disable api web interface
- Secret Key for production
- allowed host with new adress
#### React
### `npm run dev`
Runs the app in the development mode.\
`http://127.0.0.1:8000/`]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 run start`
Launches the test runner in the interactive watch mode.\
`http://127.0.0.1:8000/` in Chrome Browser
### `npm run build`
Builds the app for production to the `build` [./static/assets/]
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](https://facebook.github.io/create-react-app/docs/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](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](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](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](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](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](https://facebook.github.io/create-react-app/docs/deployment)
c4science · Help